repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
timestamp[s] | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
JanssenProject/jans | ae78b760aa536ecde3b7e7972070e144d6c3c072 | 2022-07-06T13:56:39 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/client-api-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"client-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"client-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"client-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerEnabled": {
"description": "Enable Auth server endpoints /jans-auth",
"type": "boolean"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"authServerProtectedRedisterLabels": {
"description": "Auth server protected token ingress resource labels. key app is taken",
"type": "object"
},
"configApiEnabled": {
"description": "Enable config API endpoints /jans-config-api",
"type": "boolean"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigEnabled": {
"description": "Enable endpoint /.well-known/fido2-configuration",
"type": "boolean"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigEnabled": {
"description": "Enable endpoint /.well-known/openid-configuration",
"type": "boolean"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigEnabled": {
"description": "Enable endpoint /.well-known/scim-configuration",
"type": "boolean"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimEnabled": {
"description": "Enable SCIM endpoints /jans-scim",
"type": "boolean"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigEnabled": {
"description": "Enable endpoint /.well-known/fido-configuration",
"type": "boolean"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigEnabled": {
"description": "Enable endpoint /.well-known/uma2-configuration",
"type": "boolean"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryEnabled": {
"description": "Enable endpoint /.well-known/simple-web-discovery",
"type": "boolean"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerEnabled": {
"description": "Enable endpoint /.well-known/webfinger",
"type": "boolean"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"openidConfigEnabled",
"uma2ConfigEnabled",
"webfingerEnabled",
"webdiscoveryEnabled",
"configApiEnabled",
"u2fConfigEnabled",
"authServerEnabled",
"authServerProtectedToken",
"authServerProtectedRegister",
"additionalAnnotations",
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"client-api": {
"description": "Middleware API to help application developers call an OAuth, OpenID or UMA server. You may wonder why this is necessary. It makes it easier for client developers to use OpenID signing and encryption features, without becoming crypto experts. This API provides some high level endpoints to do some of the heavy lifting.",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnClientApiBindIpAddresses": {
"$ref": "#/definitions/ip-pattern",
"description": "Client-api bind address. This limits what ip ranges can access the client-api. This should be left as * and controlled by a NetworkPolicy"
},
"cnClientApiCertCn": {
"description": "Client-api OAuth certificate common name. This should be left to the default value client-api",
"pattern": "^[a-z-]+$",
"type": "string"
},
"cnConfigGoogleSecretNamePrefix": {
"description": "Prefix for Janssen configuration secret in Google Secret Manager. Defaults to janssen. If left intact janssen-configuration secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"type": "string"
},
"cnConfigGoogleSecretVersionId": {
"description": "Secret version to be used for configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceHybridMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSecretGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"client-api": {
"properties": {
"appLoggers": {
"properties": {
"clientApiLogLevel": {
"description": "client-api.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"clientApiLogTarget": {
"description": "client-api.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"clientApiServerServiceName": {
"description": "Name of the client-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the client-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files LOCAL.",
"pattern": "^(LOCAL)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. google|kubernetes",
"pattern": "^(kubernetes|google)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. google|kubernetes",
"pattern": "^(kubernetes|google)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
},
"upgrade": {
"properties": {
"enabled": {
"description": "Boolean flag used when running helm upgrade command. This allows upgrading the chart without immutable objects errors.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | 595e705d3843a051e13cd2f416bbc0200154a105 | 2024-02-29T15:10:39 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/casa-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
},
{
"$ref": "#/definitions/saml-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"keysPushDelay": {
"description": "Delay (in seconds) before pushing private keys to Auth server",
"type": "integer"
},
"keysPushStrategy": {
"description": "Set key selection strategy after pushing private keys to Auth server",
"type": "string"
},
"keysStrategy": {
"description": "Set key selection strategy used by Auth server",
"type": "string"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"casa-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"casa": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"casa": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"saml-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"saml": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"saml": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SAML service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"casa": {
"description": "Janssen Casa (\"Casa\") is a self-service web portal for end-users to manage authentication and authorization preferences for their account in a Gluu Server.",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapCrt": {
"description": "OpenDJ certificate string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapKey": {
"description": "OpenDJ key string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceHybridMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql|pgsql|ldap)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"salt": {
"description": "Used for encoding/decoding sensitive data. If omitted or set to empty string, the value will be self-generated. Otherwise, a 24 alphanumeric characters are allowed as its value.",
"pattern": "^(?:[a-zA-Z0-9]{24})?$",
"type": "string"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"casa": {
"properties": {
"casaServiceName": {
"description": "Name of the casa service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the casa chart.",
"type": "boolean"
},
"ingress": {
"description": "Endpoint control",
"properties": {
"casaEnabled": {
"description": " Enable casa endpoints /casa",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnCouchbasePasswordFile": {
"description": "The location of the Couchbase user config.configmap.cnCouchbaseUser password. The file path must end with couchbase_password.",
"pattern": ".*couchbase_password\\b.*",
"type": "string"
},
"cnCouchbaseSuperuserPasswordFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files DB.",
"pattern": "^(DB)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnLdapCacertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.pem.",
"pattern": ".*opendj.pem\\b.*",
"type": "string"
},
"cnLdapCertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.crt.",
"pattern": ".*opendj.crt\\b.*",
"type": "string"
},
"cnLdapKeyFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.key.",
"pattern": ".*opendj.key\\b.*",
"type": "string"
},
"cnLdapPasswordFile": {
"description": "The location of the OpenDJ user password. The file path must end with ldap_password.",
"pattern": ".*ldap_password\\b.*",
"type": "string"
},
"cnLdapTruststoreFile": {
"description": "The location of the OpenDJ truststore file. The file path must end with opendj.pkcs12.",
"pattern": ".*opendj.pkcs12\\b.*",
"type": "string"
},
"cnLdapTruststorePasswordFile": {
"description": "The location of the OpenDJ truststore password file. The file path must end with ldap_truststore_password.",
"pattern": ".*ldap_truststore_password\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"cnSqlPasswordFile": {
"description": "The location of file contains password for the SQL user config.configmap.cnSqlDbUser. The file path must end with sql_password.",
"pattern": ".*sql_password\\b.*",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. vault|aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws|vault)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"link": {
"properties": {
"appLoggers": {
"properties": {
"ldapStatsLogLevel": {
"description": "cacherefresh_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "cacherefresh_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"linkLogLevel": {
"description": "cacherefresh.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"linkLogTarget": {
"description": "cacherefresh.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "cacherefresh_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "cacherefresh_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "cacherefresh_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "cacherefresh_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "cacherefresh_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the link chart.",
"type": "boolean"
},
"linkServiceName": {
"description": "Name of the link service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"saml": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the saml chart.",
"type": "boolean"
},
"ingress": {
"description": "Endpoint control",
"properties": {
"samlEnabled": {
"description": " Enable SAML endpoints /kc",
"type": "boolean"
}
},
"type": "object"
},
"samlServiceName": {
"description": "Name of the saml service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"saml": {
"description": "Jans SAML",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | acd6887963981b38563cfc8bfecfc4f71f53a68f | 2024-05-24T07:09:40 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/casa-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
},
{
"$ref": "#/definitions/saml-enabled"
},
{
"$ref": "#/definitions/kc-scheduler-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"keysPushDelay": {
"description": "Delay (in seconds) before pushing private keys to Auth server",
"type": "integer"
},
"keysPushStrategy": {
"description": "Set key selection strategy after pushing private keys to Auth server",
"type": "string"
},
"keysStrategy": {
"description": "Set key selection strategy used by Auth server",
"type": "string"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"casa-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"casa": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"casa": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"kc-scheduler-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"kc-scheduler": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"kc-scheduler": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"interval": {
"description": "Interval of running the scheduler (in minutes)",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"interval"
]
}
}
}
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"saml-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"saml": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"saml": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SAML service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"casa": {
"description": "Janssen Casa (\"Casa\") is a self-service web portal for end-users to manage authentication and authorization preferences for their account in a Gluu Server.",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapCrt": {
"description": "OpenDJ certificate string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapKey": {
"description": "OpenDJ key string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceHybridMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql|pgsql|ldap)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"salt": {
"description": "Used for encoding/decoding sensitive data. If omitted or set to empty string, the value will be self-generated. Otherwise, a 24 alphanumeric characters are allowed as its value.",
"pattern": "^(?:[a-zA-Z0-9]{24})?$",
"type": "string"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"casa": {
"properties": {
"casaServiceName": {
"description": "Name of the casa service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the casa chart.",
"type": "boolean"
},
"ingress": {
"description": "Endpoint control",
"properties": {
"casaEnabled": {
"description": " Enable casa endpoints /casa",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnCouchbasePasswordFile": {
"description": "The location of the Couchbase user config.configmap.cnCouchbaseUser password. The file path must end with couchbase_password.",
"pattern": ".*couchbase_password\\b.*",
"type": "string"
},
"cnCouchbaseSuperuserPasswordFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files DB.",
"pattern": "^(DB)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnLdapCacertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.pem.",
"pattern": ".*opendj.pem\\b.*",
"type": "string"
},
"cnLdapCertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.crt.",
"pattern": ".*opendj.crt\\b.*",
"type": "string"
},
"cnLdapKeyFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.key.",
"pattern": ".*opendj.key\\b.*",
"type": "string"
},
"cnLdapPasswordFile": {
"description": "The location of the OpenDJ user password. The file path must end with ldap_password.",
"pattern": ".*ldap_password\\b.*",
"type": "string"
},
"cnLdapTruststoreFile": {
"description": "The location of the OpenDJ truststore file. The file path must end with opendj.pkcs12.",
"pattern": ".*opendj.pkcs12\\b.*",
"type": "string"
},
"cnLdapTruststorePasswordFile": {
"description": "The location of the OpenDJ truststore password file. The file path must end with ldap_truststore_password.",
"pattern": ".*ldap_truststore_password\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"cnSqlPasswordFile": {
"description": "The location of file contains password for the SQL user config.configmap.cnSqlDbUser. The file path must end with sql_password.",
"pattern": ".*sql_password\\b.*",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. vault|aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws|vault)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"link": {
"properties": {
"appLoggers": {
"properties": {
"ldapStatsLogLevel": {
"description": "cacherefresh_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "cacherefresh_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"linkLogLevel": {
"description": "cacherefresh.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"linkLogTarget": {
"description": "cacherefresh.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "cacherefresh_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "cacherefresh_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "cacherefresh_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "cacherefresh_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "cacherefresh_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the link chart.",
"type": "boolean"
},
"linkServiceName": {
"description": "Name of the link service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"saml": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the saml chart.",
"type": "boolean"
},
"ingress": {
"description": "Endpoint control",
"properties": {
"samlEnabled": {
"description": " Enable SAML endpoints /kc",
"type": "boolean"
}
},
"type": "object"
},
"samlServiceName": {
"description": "Name of the saml service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"kc-scheduler": {
"description": "Responsible for synchronizing Keycloak SAML clients",
"properties": {},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"saml": {
"description": "Jans SAML",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | 284eda159cfb834baf7e0469a6fd0bfb10cbf383 | 2023-11-28T14:39:22 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/casa-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"keysPushDelay": {
"description": "Delay (in seconds) before pushing private keys to Auth server",
"type": "integer"
},
"keysPushStrategy": {
"description": "Set key selection strategy after pushing private keys to Auth server",
"type": "string"
},
"keysStrategy": {
"description": "Set key selection strategy used by Auth server",
"type": "string"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"casa-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"casa": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"casa": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"casa": {
"description": "Janssen Casa (\"Casa\") is a self-service web portal for end-users to manage authentication and authorization preferences for their account in a Gluu Server.",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapCrt": {
"description": "OpenDJ certificate string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapKey": {
"description": "OpenDJ key string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceHybridMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql|pgsql|ldap)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"salt": {
"description": "Used for encoding/decoding sensitive data. If omitted or set to empty string, the value will be self-generated. Otherwise, a 24 alphanumeric characters are allowed as its value.",
"pattern": "^(?:[a-zA-Z0-9]{24})?$",
"type": "string"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"casa": {
"properties": {
"casaServiceName": {
"description": "Name of the casa service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the casa chart.",
"type": "boolean"
},
"ingress": {
"description": "Endpoint control",
"properties": {
"casaEnabled": {
"description": " Enable casa endpoints /casa",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnCouchbasePasswordFile": {
"description": "The location of the Couchbase user config.configmap.cnCouchbaseUser password. The file path must end with couchbase_password.",
"pattern": ".*couchbase_password\\b.*",
"type": "string"
},
"cnCouchbaseSuperuserPasswordFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files LOCAL.",
"pattern": "^(LOCAL)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnLdapCacertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.pem.",
"pattern": ".*opendj.pem\\b.*",
"type": "string"
},
"cnLdapCertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.crt.",
"pattern": ".*opendj.crt\\b.*",
"type": "string"
},
"cnLdapKeyFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.key.",
"pattern": ".*opendj.key\\b.*",
"type": "string"
},
"cnLdapPasswordFile": {
"description": "The location of the OpenDJ user password. The file path must end with ldap_password.",
"pattern": ".*ldap_password\\b.*",
"type": "string"
},
"cnLdapTruststoreFile": {
"description": "The location of the OpenDJ truststore file. The file path must end with opendj.pkcs12.",
"pattern": ".*opendj.pkcs12\\b.*",
"type": "string"
},
"cnLdapTruststorePasswordFile": {
"description": "The location of the OpenDJ truststore password file. The file path must end with ldap_truststore_password.",
"pattern": ".*ldap_truststore_password\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"cnSqlPasswordFile": {
"description": "The location of file contains password for the SQL user config.configmap.cnSqlDbUser. The file path must end with sql_password.",
"pattern": ".*sql_password\\b.*",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"link": {
"properties": {
"appLoggers": {
"properties": {
"ldapStatsLogLevel": {
"description": "cacherefresh_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "cacherefresh_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"linkLogLevel": {
"description": "cacherefresh.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"linkLogTarget": {
"description": "cacherefresh.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "cacherefresh_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "cacherefresh_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "cacherefresh_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "cacherefresh_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "cacherefresh_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the link chart.",
"type": "boolean"
},
"linkServiceName": {
"description": "Name of the link service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | b099469cd69ce958ae89945a8aecab1f0f446322 | 2023-11-13T10:18:54 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/casa-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"keysPushDelay": {
"description": "Delay (in seconds) before pushing private keys to Auth server",
"type": "integer"
},
"keysPushStrategy": {
"description": "Set key selection strategy after pushing private keys to Auth server",
"type": "string"
},
"keysStrategy": {
"description": "Set key selection strategy used by Auth server",
"type": "string"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"casa-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"casa": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"casa": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"casa": {
"description": "Janssen Casa (\"Casa\") is a self-service web portal for end-users to manage authentication and authorization preferences for their account in a Gluu Server.",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapCrt": {
"description": "OpenDJ certificate string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapKey": {
"description": "OpenDJ key string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceHybridMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"salt": {
"description": "Used for encoding/decoding sensitive data. If omitted or set to empty string, the value will be self-generated. Otherwise, a 24 alphanumeric characters are allowed as its value.",
"pattern": "^(?:[a-zA-Z0-9]{24})?$",
"type": "string"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"casa": {
"properties": {
"casaServiceName": {
"description": "Name of the casa service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the casa chart.",
"type": "boolean"
},
"ingress": {
"description": "Endpoint control",
"properties": {
"casaEnabled": {
"description": " Enable casa endpoints /casa",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnCouchbasePasswordFile": {
"description": "The location of the Couchbase user config.configmap.cnCouchbaseUser password. The file path must end with couchbase_password.",
"pattern": ".*couchbase_password\\b.*",
"type": "string"
},
"cnCouchbaseSuperuserPasswordFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files LOCAL.",
"pattern": "^(LOCAL)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnLdapCacertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.pem.",
"pattern": ".*opendj.pem\\b.*",
"type": "string"
},
"cnLdapCertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.crt.",
"pattern": ".*opendj.crt\\b.*",
"type": "string"
},
"cnLdapKeyFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.key.",
"pattern": ".*opendj.key\\b.*",
"type": "string"
},
"cnLdapPasswordFile": {
"description": "The location of the OpenDJ user password. The file path must end with ldap_password.",
"pattern": ".*ldap_password\\b.*",
"type": "string"
},
"cnLdapTruststoreFile": {
"description": "The location of the OpenDJ truststore file. The file path must end with opendj.pkcs12.",
"pattern": ".*opendj.pkcs12\\b.*",
"type": "string"
},
"cnLdapTruststorePasswordFile": {
"description": "The location of the OpenDJ truststore password file. The file path must end with ldap_truststore_password.",
"pattern": ".*ldap_truststore_password\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"cnSqlPasswordFile": {
"description": "The location of file contains password for the SQL user config.configmap.cnSqlDbUser. The file path must end with sql_password.",
"pattern": ".*sql_password\\b.*",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"link": {
"properties": {
"appLoggers": {
"properties": {
"ldapStatsLogLevel": {
"description": "cacherefresh_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "cacherefresh_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"linkLogLevel": {
"description": "cacherefresh.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"linkLogTarget": {
"description": "cacherefresh.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "cacherefresh_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "cacherefresh_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "cacherefresh_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "cacherefresh_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "cacherefresh_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the link chart.",
"type": "boolean"
},
"linkServiceName": {
"description": "Name of the link service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | 777412b279154db2dc4ba821de39c3d271d6d6d1 | 2024-01-18T07:55:31 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/casa-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
},
{
"$ref": "#/definitions/saml-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"keysPushDelay": {
"description": "Delay (in seconds) before pushing private keys to Auth server",
"type": "integer"
},
"keysPushStrategy": {
"description": "Set key selection strategy after pushing private keys to Auth server",
"type": "string"
},
"keysStrategy": {
"description": "Set key selection strategy used by Auth server",
"type": "string"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"casa-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"casa": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"casa": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"saml-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"saml": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"saml": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SAML service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"casa": {
"description": "Janssen Casa (\"Casa\") is a self-service web portal for end-users to manage authentication and authorization preferences for their account in a Gluu Server.",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapCrt": {
"description": "OpenDJ certificate string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapKey": {
"description": "OpenDJ key string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceHybridMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql|pgsql|ldap)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"salt": {
"description": "Used for encoding/decoding sensitive data. If omitted or set to empty string, the value will be self-generated. Otherwise, a 24 alphanumeric characters are allowed as its value.",
"pattern": "^(?:[a-zA-Z0-9]{24})?$",
"type": "string"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"casa": {
"properties": {
"casaServiceName": {
"description": "Name of the casa service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the casa chart.",
"type": "boolean"
},
"ingress": {
"description": "Endpoint control",
"properties": {
"casaEnabled": {
"description": " Enable casa endpoints /casa",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnCouchbasePasswordFile": {
"description": "The location of the Couchbase user config.configmap.cnCouchbaseUser password. The file path must end with couchbase_password.",
"pattern": ".*couchbase_password\\b.*",
"type": "string"
},
"cnCouchbaseSuperuserPasswordFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files LOCAL.",
"pattern": "^(LOCAL)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnLdapCacertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.pem.",
"pattern": ".*opendj.pem\\b.*",
"type": "string"
},
"cnLdapCertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.crt.",
"pattern": ".*opendj.crt\\b.*",
"type": "string"
},
"cnLdapKeyFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.key.",
"pattern": ".*opendj.key\\b.*",
"type": "string"
},
"cnLdapPasswordFile": {
"description": "The location of the OpenDJ user password. The file path must end with ldap_password.",
"pattern": ".*ldap_password\\b.*",
"type": "string"
},
"cnLdapTruststoreFile": {
"description": "The location of the OpenDJ truststore file. The file path must end with opendj.pkcs12.",
"pattern": ".*opendj.pkcs12\\b.*",
"type": "string"
},
"cnLdapTruststorePasswordFile": {
"description": "The location of the OpenDJ truststore password file. The file path must end with ldap_truststore_password.",
"pattern": ".*ldap_truststore_password\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"cnSqlPasswordFile": {
"description": "The location of file contains password for the SQL user config.configmap.cnSqlDbUser. The file path must end with sql_password.",
"pattern": ".*sql_password\\b.*",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"link": {
"properties": {
"appLoggers": {
"properties": {
"ldapStatsLogLevel": {
"description": "cacherefresh_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "cacherefresh_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"linkLogLevel": {
"description": "cacherefresh.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"linkLogTarget": {
"description": "cacherefresh.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "cacherefresh_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "cacherefresh_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "cacherefresh_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "cacherefresh_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "cacherefresh_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the link chart.",
"type": "boolean"
},
"linkServiceName": {
"description": "Name of the link service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"saml": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the saml chart.",
"type": "boolean"
},
"ingress": {
"description": "Endpoint control",
"properties": {
"samlEnabled": {
"description": " Enable SAML endpoints /kc",
"type": "boolean"
}
},
"type": "object"
},
"samlServiceName": {
"description": "Name of the saml service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"saml": {
"description": "Jans SAML",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | 8eea271c8f790ca33d619dbcd83994bc23a7509f | 2023-03-15T13:06:52 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceHybridMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files LOCAL.",
"pattern": "^(LOCAL)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | 9dd82da5c87ee829c73a1135ce8740b8353f8ab5 | 2023-10-19T11:15:37 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/casa-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"keysPushDelay": {
"description": "Delay (in seconds) before pushing private keys to Auth server",
"type": "integer"
},
"keysPushStrategy": {
"description": "Set key selection strategy after pushing private keys to Auth server",
"type": "string"
},
"keysStrategy": {
"description": "Set key selection strategy used by Auth server",
"type": "string"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"casa-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"casa": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"casa": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"casa": {
"description": "Janssen Casa (\"Casa\") is a self-service web portal for end-users to manage authentication and authorization preferences for their account in a Gluu Server.",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapCrt": {
"description": "OpenDJ certificate string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapKey": {
"description": "OpenDJ key string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceHybridMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"casa": {
"properties": {
"casaServiceName": {
"description": "Name of the casa service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the casa chart.",
"type": "boolean"
},
"ingress": {
"description": "Endpoint control",
"properties": {
"casaEnabled": {
"description": " Enable casa endpoints /casa",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnCouchbasePasswordFile": {
"description": "The location of the Couchbase user config.configmap.cnCouchbaseUser password. The file path must end with couchbase_password.",
"pattern": ".*couchbase_password\\b.*",
"type": "string"
},
"cnCouchbaseSuperuserPasswordFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files LOCAL.",
"pattern": "^(LOCAL)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnLdapCacertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.pem.",
"pattern": ".*opendj.pem\\b.*",
"type": "string"
},
"cnLdapCertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.crt.",
"pattern": ".*opendj.crt\\b.*",
"type": "string"
},
"cnLdapKeyFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.key.",
"pattern": ".*opendj.key\\b.*",
"type": "string"
},
"cnLdapPasswordFile": {
"description": "The location of the OpenDJ user password. The file path must end with ldap_password.",
"pattern": ".*ldap_password\\b.*",
"type": "string"
},
"cnLdapTruststoreFile": {
"description": "The location of the OpenDJ truststore file. The file path must end with opendj.pkcs12.",
"pattern": ".*opendj.pkcs12\\b.*",
"type": "string"
},
"cnLdapTruststorePasswordFile": {
"description": "The location of the OpenDJ truststore password file. The file path must end with ldap_truststore_password.",
"pattern": ".*ldap_truststore_password\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"cnSqlPasswordFile": {
"description": "The location of file contains password for the SQL user config.configmap.cnSqlDbUser. The file path must end with sql_password.",
"pattern": ".*sql_password\\b.*",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"link": {
"properties": {
"appLoggers": {
"properties": {
"ldapStatsLogLevel": {
"description": "cacherefresh_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "cacherefresh_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"linkLogLevel": {
"description": "cacherefresh.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"linkLogTarget": {
"description": "cacherefresh.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "cacherefresh_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "cacherefresh_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "cacherefresh_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "cacherefresh_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "cacherefresh_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the link chart.",
"type": "boolean"
},
"linkServiceName": {
"description": "Name of the link service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | b91fd0f6692971bab889dedd954c7df7b2ecd4dc | 2022-02-14T16:59:02 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/client-api-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"client-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"client-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"client-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerEnabled": {
"description": "Enable Auth server endpoints /jans-auth",
"type": "boolean"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"authServerProtectedRedisterLabels": {
"description": "Auth server protected token ingress resource labels. key app is taken",
"type": "object"
},
"configApiEnabled": {
"description": "Enable config API endpoints /jans-config-api",
"type": "boolean"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigEnabled": {
"description": "Enable endpoint /.well-known/fido2-configuration",
"type": "boolean"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigEnabled": {
"description": "Enable endpoint /.well-known/openid-configuration",
"type": "boolean"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigEnabled": {
"description": "Enable endpoint /.well-known/scim-configuration",
"type": "boolean"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimEnabled": {
"description": "Enable SCIM endpoints /jans-scim",
"type": "boolean"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigEnabled": {
"description": "Enable endpoint /.well-known/fido-configuration",
"type": "boolean"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigEnabled": {
"description": "Enable endpoint /.well-known/uma2-configuration",
"type": "boolean"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryEnabled": {
"description": "Enable endpoint /.well-known/simple-web-discovery",
"type": "boolean"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerEnabled": {
"description": "Enable endpoint /.well-known/webfinger",
"type": "boolean"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"openidConfigEnabled",
"uma2ConfigEnabled",
"webfingerEnabled",
"webdiscoveryEnabled",
"configApiEnabled",
"u2fConfigEnabled",
"authServerEnabled",
"authServerProtectedToken",
"authServerProtectedRegister",
"additionalAnnotations",
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"multiCluster": {
"properties": {
"enabled": {
"description": "Enable OpenDJ multiCluster mode. This flag enabbles loading keys under `opendj.multiCluster`",
"type": "boolean"
},
"serfAdvertiseAddrSuffix": {
"description": "OpenDJ Serf advertise address for the cluster",
"type": "string"
},
"serfKey": {
"description": "Serf key. This key will automatically sync across clusters.",
"type": "string"
},
"serfPeers": {
"description": "Serf peer addresses. One per cluster.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"client-api": {
"description": "Middleware API to help application developers call an OAuth, OpenID or UMA server. You may wonder why this is necessary. It makes it easier for client developers to use OpenID signing and encryption features, without becoming crypto experts. This API provides some high level endpoints to do some of the heavy lifting.",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnClientApiAdminCertCn": {
"description": "Client-api OAuth client admin certificate common name. This should be left to the default value client-api",
"pattern": "^[a-z-]+$",
"type": "string"
},
"cnClientApiApplicationCertCn": {
"description": "Client-api OAuth client application certificate common name. This should be left to the default value client-api",
"pattern": "^[a-z-]+$",
"type": "string"
},
"cnClientApiBindIpAddresses": {
"$ref": "#/definitions/ip-pattern",
"description": "Client-api bind address. This limits what ip ranges can access the client-api. This should be left as * and controlled by a NetworkPolicy"
},
"cnConfigGoogleSecretNamePrefix": {
"description": "Prefix for Janssen configuration secret in Google Secret Manager. Defaults to janssen. If left intact janssen-configuration secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"type": "string"
},
"cnConfigGoogleSecretVersionId": {
"description": "Secret version to be used for configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceLdapMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"pattern": "^(default|user|site|cache|statistic)$",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSecretGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"client-api": {
"properties": {
"appLoggers": {
"properties": {
"clientApiLogLevel": {
"description": "client-api.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"clientApiLogTarget": {
"description": "client-api.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"clientApiServerServiceName": {
"description": "Name of the client-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the client-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files LOCAL.",
"pattern": "^(LOCAL)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. google|kubernetes",
"pattern": "^(kubernetes|google)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. google|kubernetes",
"pattern": "^(kubernetes|google)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
},
"upgrade": {
"properties": {
"enabled": {
"description": "Boolean flag used when running helm upgrade command. This allows upgrading the chart without immutable objects errors.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | 2407a2cd90723000b75b8260446bbe3ec91c418c | 2022-10-26T07:41:58 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnConfigGoogleSecretNamePrefix": {
"description": "Prefix for Janssen configuration secret in Google Secret Manager. Defaults to janssen. If left intact janssen-configuration secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"type": "string"
},
"cnConfigGoogleSecretVersionId": {
"description": "Secret version to be used for configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceHybridMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSecretGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files LOCAL.",
"pattern": "^(LOCAL)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. google|kubernetes",
"pattern": "^(kubernetes|google)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. google|kubernetes",
"pattern": "^(kubernetes|google)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
},
"upgrade": {
"properties": {
"enabled": {
"description": "Boolean flag used when running helm upgrade command. This allows upgrading the chart without immutable objects errors.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | ef43fab22b5bfa8ae8dcf0cffb8c544326c88d01 | 2023-05-22T07:52:23 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"keysPushDelay": {
"description": "Delay (in seconds) before pushing private keys to Auth server",
"type": "integer"
},
"keysPushStrategy": {
"description": "Set key selection strategy after pushing private keys to Auth server",
"type": "string"
},
"keysStrategy": {
"description": "Set key selection strategy used by Auth server",
"type": "string"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceHybridMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files LOCAL.",
"pattern": "^(LOCAL)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | bee17a7a69de7872ee54ea1edc3dd01a7da21417 | 2023-01-23T09:14:10 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnConfigGoogleSecretNamePrefix": {
"description": "Prefix for Janssen configuration secret in Google Secret Manager. Defaults to janssen. If left intact janssen-configuration secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"type": "string"
},
"cnConfigGoogleSecretVersionId": {
"description": "Secret version to be used for configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceHybridMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSecretGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files LOCAL.",
"pattern": "^(LOCAL)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | eb4e84a3b7fbf9a3ad778b3cc77b40dec3210e5d | 2023-10-05T08:36:47 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/casa-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"keysPushDelay": {
"description": "Delay (in seconds) before pushing private keys to Auth server",
"type": "integer"
},
"keysPushStrategy": {
"description": "Set key selection strategy after pushing private keys to Auth server",
"type": "string"
},
"keysStrategy": {
"description": "Set key selection strategy used by Auth server",
"type": "string"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"casa-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"casa": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"casa": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"casa": {
"description": "Janssen Casa (\"Casa\") is a self-service web portal for end-users to manage authentication and authorization preferences for their account in a Gluu Server.",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceHybridMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"casa": {
"properties": {
"casaServiceName": {
"description": "Name of the casa service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the casa chart.",
"type": "boolean"
},
"ingress": {
"description": "Endpoint control",
"properties": {
"casaEnabled": {
"description": " Enable casa endpoints /casa",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files LOCAL.",
"pattern": "^(LOCAL)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"link": {
"properties": {
"appLoggers": {
"properties": {
"ldapStatsLogLevel": {
"description": "cacherefresh_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "cacherefresh_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"linkLogLevel": {
"description": "cacherefresh.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"linkLogTarget": {
"description": "cacherefresh.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "cacherefresh_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "cacherefresh_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "cacherefresh_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "cacherefresh_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "cacherefresh_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the link chart.",
"type": "boolean"
},
"linkServiceName": {
"description": "Name of the link service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | 1b63861cb21334a1d0ae3247468c776e4e624845 | 2023-11-28T15:40:36 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/casa-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"keysPushDelay": {
"description": "Delay (in seconds) before pushing private keys to Auth server",
"type": "integer"
},
"keysPushStrategy": {
"description": "Set key selection strategy after pushing private keys to Auth server",
"type": "string"
},
"keysStrategy": {
"description": "Set key selection strategy used by Auth server",
"type": "string"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"casa-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"casa": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"casa": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"casa": {
"description": "Janssen Casa (\"Casa\") is a self-service web portal for end-users to manage authentication and authorization preferences for their account in a Gluu Server.",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapCrt": {
"description": "OpenDJ certificate string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapKey": {
"description": "OpenDJ key string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceHybridMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql|pgsql|ldap)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"salt": {
"description": "Used for encoding/decoding sensitive data. If omitted or set to empty string, the value will be self-generated. Otherwise, a 24 alphanumeric characters are allowed as its value.",
"pattern": "^(?:[a-zA-Z0-9]{24})?$",
"type": "string"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"casa": {
"properties": {
"casaServiceName": {
"description": "Name of the casa service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the casa chart.",
"type": "boolean"
},
"ingress": {
"description": "Endpoint control",
"properties": {
"casaEnabled": {
"description": " Enable casa endpoints /casa",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnCouchbasePasswordFile": {
"description": "The location of the Couchbase user config.configmap.cnCouchbaseUser password. The file path must end with couchbase_password.",
"pattern": ".*couchbase_password\\b.*",
"type": "string"
},
"cnCouchbaseSuperuserPasswordFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files LOCAL.",
"pattern": "^(LOCAL)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnLdapCacertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.pem.",
"pattern": ".*opendj.pem\\b.*",
"type": "string"
},
"cnLdapCertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.crt.",
"pattern": ".*opendj.crt\\b.*",
"type": "string"
},
"cnLdapKeyFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.key.",
"pattern": ".*opendj.key\\b.*",
"type": "string"
},
"cnLdapPasswordFile": {
"description": "The location of the OpenDJ user password. The file path must end with ldap_password.",
"pattern": ".*ldap_password\\b.*",
"type": "string"
},
"cnLdapTruststoreFile": {
"description": "The location of the OpenDJ truststore file. The file path must end with opendj.pkcs12.",
"pattern": ".*opendj.pkcs12\\b.*",
"type": "string"
},
"cnLdapTruststorePasswordFile": {
"description": "The location of the OpenDJ truststore password file. The file path must end with ldap_truststore_password.",
"pattern": ".*ldap_truststore_password\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"cnSqlPasswordFile": {
"description": "The location of file contains password for the SQL user config.configmap.cnSqlDbUser. The file path must end with sql_password.",
"pattern": ".*sql_password\\b.*",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"link": {
"properties": {
"appLoggers": {
"properties": {
"ldapStatsLogLevel": {
"description": "cacherefresh_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "cacherefresh_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"linkLogLevel": {
"description": "cacherefresh.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"linkLogTarget": {
"description": "cacherefresh.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "cacherefresh_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "cacherefresh_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "cacherefresh_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "cacherefresh_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "cacherefresh_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the link chart.",
"type": "boolean"
},
"linkServiceName": {
"description": "Name of the link service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | 0522e61809b9052adce4fdb0db77e2d71558144e | 2022-11-30T13:47:16 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnConfigGoogleSecretNamePrefix": {
"description": "Prefix for Janssen configuration secret in Google Secret Manager. Defaults to janssen. If left intact janssen-configuration secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"type": "string"
},
"cnConfigGoogleSecretVersionId": {
"description": "Secret version to be used for configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceHybridMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSecretGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files LOCAL.",
"pattern": "^(LOCAL)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
},
"upgrade": {
"properties": {
"enabled": {
"description": "Boolean flag used when running helm upgrade command. This allows upgrading the chart without immutable objects errors.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | ed47585843ea1d08366f530f27e94ab77e3439d9 | 2023-11-16T07:16:56 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/casa-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"keysPushDelay": {
"description": "Delay (in seconds) before pushing private keys to Auth server",
"type": "integer"
},
"keysPushStrategy": {
"description": "Set key selection strategy after pushing private keys to Auth server",
"type": "string"
},
"keysStrategy": {
"description": "Set key selection strategy used by Auth server",
"type": "string"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"casa-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"casa": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"casa": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"casa": {
"description": "Janssen Casa (\"Casa\") is a self-service web portal for end-users to manage authentication and authorization preferences for their account in a Gluu Server.",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapCrt": {
"description": "OpenDJ certificate string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapKey": {
"description": "OpenDJ key string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceHybridMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql|pgsql)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"salt": {
"description": "Used for encoding/decoding sensitive data. If omitted or set to empty string, the value will be self-generated. Otherwise, a 24 alphanumeric characters are allowed as its value.",
"pattern": "^(?:[a-zA-Z0-9]{24})?$",
"type": "string"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"casa": {
"properties": {
"casaServiceName": {
"description": "Name of the casa service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the casa chart.",
"type": "boolean"
},
"ingress": {
"description": "Endpoint control",
"properties": {
"casaEnabled": {
"description": " Enable casa endpoints /casa",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnCouchbasePasswordFile": {
"description": "The location of the Couchbase user config.configmap.cnCouchbaseUser password. The file path must end with couchbase_password.",
"pattern": ".*couchbase_password\\b.*",
"type": "string"
},
"cnCouchbaseSuperuserPasswordFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files LOCAL.",
"pattern": "^(LOCAL)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnLdapCacertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.pem.",
"pattern": ".*opendj.pem\\b.*",
"type": "string"
},
"cnLdapCertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.crt.",
"pattern": ".*opendj.crt\\b.*",
"type": "string"
},
"cnLdapKeyFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.key.",
"pattern": ".*opendj.key\\b.*",
"type": "string"
},
"cnLdapPasswordFile": {
"description": "The location of the OpenDJ user password. The file path must end with ldap_password.",
"pattern": ".*ldap_password\\b.*",
"type": "string"
},
"cnLdapTruststoreFile": {
"description": "The location of the OpenDJ truststore file. The file path must end with opendj.pkcs12.",
"pattern": ".*opendj.pkcs12\\b.*",
"type": "string"
},
"cnLdapTruststorePasswordFile": {
"description": "The location of the OpenDJ truststore password file. The file path must end with ldap_truststore_password.",
"pattern": ".*ldap_truststore_password\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"cnSqlPasswordFile": {
"description": "The location of file contains password for the SQL user config.configmap.cnSqlDbUser. The file path must end with sql_password.",
"pattern": ".*sql_password\\b.*",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"link": {
"properties": {
"appLoggers": {
"properties": {
"ldapStatsLogLevel": {
"description": "cacherefresh_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "cacherefresh_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"linkLogLevel": {
"description": "cacherefresh.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"linkLogTarget": {
"description": "cacherefresh.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "cacherefresh_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "cacherefresh_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "cacherefresh_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "cacherefresh_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "cacherefresh_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the link chart.",
"type": "boolean"
},
"linkServiceName": {
"description": "Name of the link service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | 251711505c4dc094271f542f99d0f2bf2c26131e | 2024-02-05T07:17:51 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/casa-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
},
{
"$ref": "#/definitions/saml-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"keysPushDelay": {
"description": "Delay (in seconds) before pushing private keys to Auth server",
"type": "integer"
},
"keysPushStrategy": {
"description": "Set key selection strategy after pushing private keys to Auth server",
"type": "string"
},
"keysStrategy": {
"description": "Set key selection strategy used by Auth server",
"type": "string"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"casa-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"casa": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"casa": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"saml-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"saml": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"saml": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SAML service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"casa": {
"description": "Janssen Casa (\"Casa\") is a self-service web portal for end-users to manage authentication and authorization preferences for their account in a Gluu Server.",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapCrt": {
"description": "OpenDJ certificate string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapKey": {
"description": "OpenDJ key string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceHybridMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql|pgsql|ldap)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"salt": {
"description": "Used for encoding/decoding sensitive data. If omitted or set to empty string, the value will be self-generated. Otherwise, a 24 alphanumeric characters are allowed as its value.",
"pattern": "^(?:[a-zA-Z0-9]{24})?$",
"type": "string"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"casa": {
"properties": {
"casaServiceName": {
"description": "Name of the casa service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the casa chart.",
"type": "boolean"
},
"ingress": {
"description": "Endpoint control",
"properties": {
"casaEnabled": {
"description": " Enable casa endpoints /casa",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnCouchbasePasswordFile": {
"description": "The location of the Couchbase user config.configmap.cnCouchbaseUser password. The file path must end with couchbase_password.",
"pattern": ".*couchbase_password\\b.*",
"type": "string"
},
"cnCouchbaseSuperuserPasswordFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files DB.",
"pattern": "^(DB)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnLdapCacertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.pem.",
"pattern": ".*opendj.pem\\b.*",
"type": "string"
},
"cnLdapCertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.crt.",
"pattern": ".*opendj.crt\\b.*",
"type": "string"
},
"cnLdapKeyFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.key.",
"pattern": ".*opendj.key\\b.*",
"type": "string"
},
"cnLdapPasswordFile": {
"description": "The location of the OpenDJ user password. The file path must end with ldap_password.",
"pattern": ".*ldap_password\\b.*",
"type": "string"
},
"cnLdapTruststoreFile": {
"description": "The location of the OpenDJ truststore file. The file path must end with opendj.pkcs12.",
"pattern": ".*opendj.pkcs12\\b.*",
"type": "string"
},
"cnLdapTruststorePasswordFile": {
"description": "The location of the OpenDJ truststore password file. The file path must end with ldap_truststore_password.",
"pattern": ".*ldap_truststore_password\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"cnSqlPasswordFile": {
"description": "The location of file contains password for the SQL user config.configmap.cnSqlDbUser. The file path must end with sql_password.",
"pattern": ".*sql_password\\b.*",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"link": {
"properties": {
"appLoggers": {
"properties": {
"ldapStatsLogLevel": {
"description": "cacherefresh_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "cacherefresh_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"linkLogLevel": {
"description": "cacherefresh.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"linkLogTarget": {
"description": "cacherefresh.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "cacherefresh_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "cacherefresh_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "cacherefresh_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "cacherefresh_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "cacherefresh_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the link chart.",
"type": "boolean"
},
"linkServiceName": {
"description": "Name of the link service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"saml": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the saml chart.",
"type": "boolean"
},
"ingress": {
"description": "Endpoint control",
"properties": {
"samlEnabled": {
"description": " Enable SAML endpoints /kc",
"type": "boolean"
}
},
"type": "object"
},
"samlServiceName": {
"description": "Name of the saml service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"saml": {
"description": "Jans SAML",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | abff9b8766c168af8ea974fdb85973f96af7fa10 | 2024-05-13T06:40:07 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/casa-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
},
{
"$ref": "#/definitions/saml-enabled"
},
{
"$ref": "#/definitions/kc-scheduler-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"keysPushDelay": {
"description": "Delay (in seconds) before pushing private keys to Auth server",
"type": "integer"
},
"keysPushStrategy": {
"description": "Set key selection strategy after pushing private keys to Auth server",
"type": "string"
},
"keysStrategy": {
"description": "Set key selection strategy used by Auth server",
"type": "string"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"casa-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"casa": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"casa": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"kc-scheduler-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"kc-scheduler": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"kc-scheduler": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"interval": {
"description": "Interval of running the scheduler (in minutes)",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"interval"
]
}
}
}
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"saml-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"saml": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"saml": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SAML service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"casa": {
"description": "Janssen Casa (\"Casa\") is a self-service web portal for end-users to manage authentication and authorization preferences for their account in a Gluu Server.",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapCrt": {
"description": "OpenDJ certificate string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapKey": {
"description": "OpenDJ key string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceHybridMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql|pgsql|ldap)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"salt": {
"description": "Used for encoding/decoding sensitive data. If omitted or set to empty string, the value will be self-generated. Otherwise, a 24 alphanumeric characters are allowed as its value.",
"pattern": "^(?:[a-zA-Z0-9]{24})?$",
"type": "string"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"casa": {
"properties": {
"casaServiceName": {
"description": "Name of the casa service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the casa chart.",
"type": "boolean"
},
"ingress": {
"description": "Endpoint control",
"properties": {
"casaEnabled": {
"description": " Enable casa endpoints /casa",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnCouchbasePasswordFile": {
"description": "The location of the Couchbase user config.configmap.cnCouchbaseUser password. The file path must end with couchbase_password.",
"pattern": ".*couchbase_password\\b.*",
"type": "string"
},
"cnCouchbaseSuperuserPasswordFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files DB.",
"pattern": "^(DB)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnLdapCacertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.pem.",
"pattern": ".*opendj.pem\\b.*",
"type": "string"
},
"cnLdapCertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.crt.",
"pattern": ".*opendj.crt\\b.*",
"type": "string"
},
"cnLdapKeyFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.key.",
"pattern": ".*opendj.key\\b.*",
"type": "string"
},
"cnLdapPasswordFile": {
"description": "The location of the OpenDJ user password. The file path must end with ldap_password.",
"pattern": ".*ldap_password\\b.*",
"type": "string"
},
"cnLdapTruststoreFile": {
"description": "The location of the OpenDJ truststore file. The file path must end with opendj.pkcs12.",
"pattern": ".*opendj.pkcs12\\b.*",
"type": "string"
},
"cnLdapTruststorePasswordFile": {
"description": "The location of the OpenDJ truststore password file. The file path must end with ldap_truststore_password.",
"pattern": ".*ldap_truststore_password\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"cnSqlPasswordFile": {
"description": "The location of file contains password for the SQL user config.configmap.cnSqlDbUser. The file path must end with sql_password.",
"pattern": ".*sql_password\\b.*",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. vault|aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws|vault)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"link": {
"properties": {
"appLoggers": {
"properties": {
"ldapStatsLogLevel": {
"description": "cacherefresh_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "cacherefresh_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"linkLogLevel": {
"description": "cacherefresh.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"linkLogTarget": {
"description": "cacherefresh.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "cacherefresh_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "cacherefresh_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "cacherefresh_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "cacherefresh_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "cacherefresh_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the link chart.",
"type": "boolean"
},
"linkServiceName": {
"description": "Name of the link service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"saml": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the saml chart.",
"type": "boolean"
},
"ingress": {
"description": "Endpoint control",
"properties": {
"samlEnabled": {
"description": " Enable SAML endpoints /kc",
"type": "boolean"
}
},
"type": "object"
},
"samlServiceName": {
"description": "Name of the saml service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"kc-scheduler": {
"description": "Responsible for synchronizing Keycloak SAML clients",
"properties": {},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"saml": {
"description": "Jans SAML",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | 6f04075fdeacd4b52ef417feef9d5982b5c3062e | 2022-05-20T06:50:27 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/client-api-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"client-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"client-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"client-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerEnabled": {
"description": "Enable Auth server endpoints /jans-auth",
"type": "boolean"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"authServerProtectedRedisterLabels": {
"description": "Auth server protected token ingress resource labels. key app is taken",
"type": "object"
},
"configApiEnabled": {
"description": "Enable config API endpoints /jans-config-api",
"type": "boolean"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigEnabled": {
"description": "Enable endpoint /.well-known/fido2-configuration",
"type": "boolean"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigEnabled": {
"description": "Enable endpoint /.well-known/openid-configuration",
"type": "boolean"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigEnabled": {
"description": "Enable endpoint /.well-known/scim-configuration",
"type": "boolean"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimEnabled": {
"description": "Enable SCIM endpoints /jans-scim",
"type": "boolean"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigEnabled": {
"description": "Enable endpoint /.well-known/fido-configuration",
"type": "boolean"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigEnabled": {
"description": "Enable endpoint /.well-known/uma2-configuration",
"type": "boolean"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryEnabled": {
"description": "Enable endpoint /.well-known/simple-web-discovery",
"type": "boolean"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerEnabled": {
"description": "Enable endpoint /.well-known/webfinger",
"type": "boolean"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"openidConfigEnabled",
"uma2ConfigEnabled",
"webfingerEnabled",
"webdiscoveryEnabled",
"configApiEnabled",
"u2fConfigEnabled",
"authServerEnabled",
"authServerProtectedToken",
"authServerProtectedRegister",
"additionalAnnotations",
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"client-api": {
"description": "Middleware API to help application developers call an OAuth, OpenID or UMA server. You may wonder why this is necessary. It makes it easier for client developers to use OpenID signing and encryption features, without becoming crypto experts. This API provides some high level endpoints to do some of the heavy lifting.",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnClientApiAdminCertCn": {
"description": "Client-api OAuth client admin certificate common name. This should be left to the default value client-api",
"pattern": "^[a-z-]+$",
"type": "string"
},
"cnClientApiApplicationCertCn": {
"description": "Client-api OAuth client application certificate common name. This should be left to the default value client-api",
"pattern": "^[a-z-]+$",
"type": "string"
},
"cnClientApiBindIpAddresses": {
"$ref": "#/definitions/ip-pattern",
"description": "Client-api bind address. This limits what ip ranges can access the client-api. This should be left as * and controlled by a NetworkPolicy"
},
"cnConfigGoogleSecretNamePrefix": {
"description": "Prefix for Janssen configuration secret in Google Secret Manager. Defaults to janssen. If left intact janssen-configuration secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"type": "string"
},
"cnConfigGoogleSecretVersionId": {
"description": "Secret version to be used for configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceLdapMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"pattern": "^(default|user|site|cache|statistic)$",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSecretGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"client-api": {
"properties": {
"appLoggers": {
"properties": {
"clientApiLogLevel": {
"description": "client-api.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"clientApiLogTarget": {
"description": "client-api.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"clientApiServerServiceName": {
"description": "Name of the client-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the client-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files LOCAL.",
"pattern": "^(LOCAL)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. google|kubernetes",
"pattern": "^(kubernetes|google)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. google|kubernetes",
"pattern": "^(kubernetes|google)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
},
"upgrade": {
"properties": {
"enabled": {
"description": "Boolean flag used when running helm upgrade command. This allows upgrading the chart without immutable objects errors.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | cdc0a13554fccbe370c75a8624c75dd232223a8d | 2023-07-24T14:05:16 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"keysPushDelay": {
"description": "Delay (in seconds) before pushing private keys to Auth server",
"type": "integer"
},
"keysPushStrategy": {
"description": "Set key selection strategy after pushing private keys to Auth server",
"type": "string"
},
"keysStrategy": {
"description": "Set key selection strategy used by Auth server",
"type": "string"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceHybridMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files LOCAL.",
"pattern": "^(LOCAL)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"link": {
"properties": {
"appLoggers": {
"properties": {
"ldapStatsLogLevel": {
"description": "cacherefresh_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "cacherefresh_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"linkLogLevel": {
"description": "cacherefresh.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"linkLogTarget": {
"description": "cacherefresh.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "cacherefresh_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "cacherefresh_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "cacherefresh_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "cacherefresh_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "cacherefresh_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the link chart.",
"type": "boolean"
},
"linkServiceName": {
"description": "Name of the link service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | a797c6139da3f5ada9c054ef596a4a13b94f8a1b | 2023-01-31T14:39:32 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceHybridMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files LOCAL.",
"pattern": "^(LOCAL)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | e74ea8e27e59d35ff6e3c6f997e6c1df6a04ec83 | 2022-10-17T15:26:58 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerEnabled": {
"description": "Enable Auth server endpoints /jans-auth",
"type": "boolean"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"authServerProtectedRedisterLabels": {
"description": "Auth server protected token ingress resource labels. key app is taken",
"type": "object"
},
"configApiEnabled": {
"description": "Enable config API endpoints /jans-config-api",
"type": "boolean"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigEnabled": {
"description": "Enable endpoint /.well-known/fido2-configuration",
"type": "boolean"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigEnabled": {
"description": "Enable endpoint /.well-known/openid-configuration",
"type": "boolean"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigEnabled": {
"description": "Enable endpoint /.well-known/scim-configuration",
"type": "boolean"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimEnabled": {
"description": "Enable SCIM endpoints /jans-scim",
"type": "boolean"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigEnabled": {
"description": "Enable endpoint /.well-known/fido-configuration",
"type": "boolean"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigEnabled": {
"description": "Enable endpoint /.well-known/uma2-configuration",
"type": "boolean"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryEnabled": {
"description": "Enable endpoint /.well-known/simple-web-discovery",
"type": "boolean"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerEnabled": {
"description": "Enable endpoint /.well-known/webfinger",
"type": "boolean"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"openidConfigEnabled",
"uma2ConfigEnabled",
"webfingerEnabled",
"webdiscoveryEnabled",
"configApiEnabled",
"u2fConfigEnabled",
"authServerEnabled",
"authServerProtectedToken",
"authServerProtectedRegister",
"additionalAnnotations",
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnConfigGoogleSecretNamePrefix": {
"description": "Prefix for Janssen configuration secret in Google Secret Manager. Defaults to janssen. If left intact janssen-configuration secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"type": "string"
},
"cnConfigGoogleSecretVersionId": {
"description": "Secret version to be used for configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceHybridMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSecretGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files LOCAL.",
"pattern": "^(LOCAL)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. google|kubernetes",
"pattern": "^(kubernetes|google)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. google|kubernetes",
"pattern": "^(kubernetes|google)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"$ref": "#/definitions/ip-pattern",
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
},
"upgrade": {
"properties": {
"enabled": {
"description": "Boolean flag used when running helm upgrade command. This allows upgrading the chart without immutable objects errors.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
JanssenProject/jans | 600c5ab76e82bc63c412c5811986c0a7e7212ec0 | 2023-11-28T14:59:39 | charts/janssen/values.schema.json | 405 | 2024-05-29T08:25:04.252132Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"allOf": [
{
"$ref": "#/definitions/auth-server-enabled"
},
{
"$ref": "#/definitions/auth-server-key-rotation-enabled"
},
{
"$ref": "#/definitions/config-api-enabled"
},
{
"$ref": "#/definitions/casa-enabled"
},
{
"$ref": "#/definitions/fido2-enabled"
},
{
"$ref": "#/definitions/nginx-ingress-enabled"
},
{
"$ref": "#/definitions/opendj-enabled"
},
{
"$ref": "#/definitions/persistence-enabled"
},
{
"$ref": "#/definitions/scim-enabled"
}
],
"definitions": {
"auth-server-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"auth-server-key-rotation-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"auth-server-key-rotation": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"keysLife": {
"description": "Auth server key rotation keys life in hours",
"type": "integer"
},
"keysPushDelay": {
"description": "Delay (in seconds) before pushing private keys to Auth server",
"type": "integer"
},
"keysPushStrategy": {
"description": "Set key selection strategy after pushing private keys to Auth server",
"type": "string"
},
"keysStrategy": {
"description": "Set key selection strategy used by Auth server",
"type": "string"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources",
"keysLife"
]
}
}
}
},
"casa-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"casa": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"casa": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
]
}
}
}
},
"config-api-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"config-api": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"config-api": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources"
],
"type": "object"
}
}
}
},
"email-format": {
"format": "email",
"type": "string"
},
"fido2-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"fido2": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"fido2": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"fido2ServiceName": {
"description": "Name of the Fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"fqdn-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Setting not FQDN structured. Please enter a FQDN with the format demoexample.jans.io"
},
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"ip-pattern": {
"anyOf": [
{
"errors": {
"pattern": "Not a valid IP."
},
"pattern": "^(\\*|((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))$",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"nginx-ingress-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"nginx-ingress": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"nginx-ingress": {
"properties": {
"ingress": {
"properties": {
"additionalAnnotations": {
"description": "Additional annotations that will be added across all ingress definitions in the format of {cert-manager.io/issuer: \"letsencrypt-prod\"}",
"type": "object"
},
"authServerLabels": {
"description": "Auth server config ingress resource labels. key app is taken",
"type": "object"
},
"configApiLabels": {
"description": "configAPI ingress resource labels. key app is taken",
"type": "object"
},
"fido2ConfigLabels": {
"description": "fido2 ingress resource labels. key app is taken",
"type": "object"
},
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"openidConfigLabels": {
"description": "openid-configuration ingress resource labels. key app is taken",
"type": "object"
},
"path": {
"type": "string"
},
"scimConfigLabels": {
"description": "SCIM config ingress resource labels. key app is taken",
"type": "object"
},
"scimLabels": {
"description": "SCIM ingress resource labels. key app is taken",
"type": "object"
},
"tls": {
"description": "Secret holding HTTPS CA cert and key.",
"items": {
"properties": {
"hosts": {
"items": {
"$ref": "#/definitions/fqdn-pattern"
},
"type": "array"
},
"secretName": {
"pattern": "^[a-z-]+$",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"u2fConfigLabels": {
"description": "u2f ingress resource labels. key app is taken",
"type": "object"
},
"uma2ConfigLabels": {
"description": "uma2 config ingress resource labels. key app is taken",
"type": "object"
},
"webdiscoveryLabels": {
"description": "webdiscovery ingress resource labels. key app is taken",
"type": "object"
},
"webfingerLabels": {
"description": "webfinger ingress resource labels. key app is taken",
"type": "object"
}
},
"required": [
"path",
"hosts",
"tls"
],
"type": "object"
}
},
"type": "object"
}
}
}
},
"opendj-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"opendj": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"opendj": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"description": "OpenDJ volume size",
"pattern": "^[0-9]Gi+$",
"type": "string"
}
},
"type": "object"
},
"ports": {
"properties": {
"tcp-admin": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldap": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-ldaps": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-repl": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"tcp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
},
"udp-serf": {
"properties": {
"nodePort": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
},
"targetPort": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"password": {
"anyOf": [
{
"description": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol",
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 8,
"pattern": "",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
},
"password-pattern": {
"errors": {
"minLength": "Password minimum 6 character",
"pattern": "Password does not meet requirements. The password must contain one digit, one uppercase letter, one lower case letter and one symbol"
},
"minLength": 6,
"pattern": "",
"type": "string"
},
"persistence-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"persistence": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"persistence": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"resources"
],
"type": "object"
}
}
}
},
"scim-enabled": {
"else": true,
"if": {
"properties": {
"global": {
"properties": {
"scim": {
"properties": {
"enabled": {
"const": "true"
}
}
}
}
}
}
},
"then": {
"properties": {
"scim": {
"properties": {
"dnsConfig": {
"description": "Add custom dns config",
"type": "object"
},
"dnsPolicy": {
"description": "Add custom dns policy",
"pattern": "^(Default|ClusterFirst|ClusterFirstWithHostNet|None|)$",
"type": "string"
},
"hpa": {
"description": "Configure the HorizontalPodAutoscaler",
"properties": {
"behavior": {
"description": "Scaling Policies",
"type": "object"
},
"enabled": {
"type": "boolean"
},
"maxReplicas": {
"type": "integer"
},
"metrics": {
"description": "metrics if targetCPUUtilizationPercentage is not set",
"type": "array"
},
"minReplicas": {
"type": "integer"
},
"targetCPUUtilizationPercentage": {
"type": "integer"
}
},
"type": "object"
},
"image": {
"properties": {
"pullPolicy": {
"description": "Image pullPolicy to use for deploying.",
"pattern": "^(Always|Never|IfNotPresent)$",
"type": "string"
},
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"replicas": {
"description": "Service replica number.",
"type": "integer"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"properties": {
"scimServiceName": {
"description": "Name of the SCIM service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"usrEnvs": {
"description": "Add custom normal and secret envs to the service",
"properties": {
"normal": {
"description": "Add custom normal envs to the service",
"type": "object"
},
"secret": {
"description": "Add custom secret envs to the service",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"image",
"replicas",
"resources",
"service"
],
"type": "object"
}
}
}
},
"url-pattern": {
"anyOf": [
{
"errors": {
"pattern": "URL pattern is not meeting standards."
},
"pattern": "(^|\\s)((https?:\\/\\/)?[\\w-]+(\\.[\\w-]+)+\\.?(:\\d+)?(\\/\\S*)?)",
"type": "string"
},
{
"maxLength": 0,
"type": "string"
}
]
}
},
"properties": {
"auth-server": {
"description": "OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.",
"properties": {},
"type": "object"
},
"auth-server-key-rotation": {
"description": "Responsible for regenerating auth-keys per x hours",
"properties": {},
"type": "object"
},
"casa": {
"description": "Janssen Casa (\"Casa\") is a self-service web portal for end-users to manage authentication and authorization preferences for their account in a Gluu Server.",
"properties": {},
"type": "object"
},
"config": {
"description": "Configuration parameters for setup and initial configuration secret annd config layers used by Janssen services.",
"properties": {
"adminPass": {
"$ref": "#/definitions/password",
"description": "Admin password to login to the UI"
},
"city": {
"description": "City of the company or individual. Used in generating the self-signed certificate",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"configmap": {
"description": "Configuration parameters mapped to envs in a ConfigMap",
"properties": {
"cnCacheType": {
"description": "Cache type. NATIVE_PERSISTENCE, REDIS. or IN_MEMORY. Defaults to NATIVE_PERSISTENCE",
"pattern": "^(NATIVE_PERSISTENCE|REDIS|IN_MEMORY)$",
"type": "string"
},
"cnConfigKubernetesConfigMap": {
"description": "The name of the ConfigMap that will hold the configuration layer",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseBucketPrefix": {
"description": "The prefix of couchbase buckets. This helps with separation in between different environments and allows for the same couchbase cluster to be used by different setups of Janssen.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseCrt": {
"description": "Couchbase certificate authority string. This must be encoded using base64. This can also be found in your couchbase UI Security > Root Certificate. In mTLS setups this is not required.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnCouchbaseIndexNumReplica": {
"description": "The number of replicas per index created. Please note that the number of index nodes must be one greater than the number of index replicas. That means if your couchbase cluster only has 2 index nodes you cannot place the number of replicas to be higher than 1.",
"type": "integer"
},
"cnCouchbasePass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the restricted user config.configmap.cnCouchbaseUser that is often used inside the services. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUser": {
"description": "The Couchbase super user (admin) user name. This user is used during initialization only.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnCouchbaseSuperUserPass": {
"$ref": "#/definitions/password",
"description": "Couchbase password for the super user config.configmap.cnCouchbaseSuperUser that is used during the initialization process. The password must contain one digit, one uppercase letter, one lower case letter and one symbol "
},
"cnCouchbaseSuperUserPassFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnCouchbaseUrl": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Couchbase URL. Used only when global.cnPersistenceType is hybrid or couchbase. This should be in FQDN format for either remote or local Couchbase clusters. The address can be an internal address inside the kubernetes cluster"
},
"cnCouchbaseUser": {
"description": "Couchbase restricted user. Used only when global.cnPersistenceType is hybrid or couchbase.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleProjectId": {
"description": "Project id of the google project the secret manager belongs to. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "",
"type": "string"
},
"cnGoogleSecretManagerPassPhrase": {
"$ref": "#/definitions/password",
"description": "Passphrase for Janssen secret in Google Secret Manager. This is used for encrypting and decrypting data from the Google Secret Manager. Used only when global.configAdapterName and global.configSecretAdapter is set to google."
},
"cnGoogleSecretManagerServiceAccount": {
"description": "Service account with roles roles/secretmanager.admin base64 encoded string. This is used often inside the services to reach the configuration layer. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnGoogleSecretNamePrefix": {
"description": "Prefix for Janssen secret in Google Secret Manager. Defaults to janssen. If left janssen-secret secret will be created. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnGoogleSecretVersionId": {
"description": "Secret version to be used for secret configuration. Defaults to latest and should normally always stay that way. Used only when global.configAdapterName and global.configSecretAdapter is set to google.",
"pattern": "^([0-9]|latest)*$",
"type": "string"
},
"cnGoogleSpannerDatabaseId": {
"description": "Google Spanner Database ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^[a-z0-9\\-]*$",
"type": "string"
},
"cnGoogleSpannerInstanceId": {
"description": "Google Spanner ID. Used only when global.cnPersistenceType is spanner.",
"pattern": "^([a-z0-9\\-])*$",
"type": "string"
},
"cnLdapCrt": {
"description": "OpenDJ certificate string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapKey": {
"description": "OpenDJ key string. This must be encoded using base64.",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"type": "string"
},
"cnLdapUrl": {
"description": "OpenDJ internal address. Leave as default. Used when `global.cnPersistenceType` is set to `ldap`.",
"pattern": "^[a-z0-9-:]+$",
"type": "string"
},
"cnMaxRamPercent": {
"description": "Value passed to Java option -XX:MaxRAMPercentage",
"pattern": "^(\\d{0,2}(\\.\\d{1,2})?|100(\\.0?)?)$",
"type": "string"
},
"cnPersistenceHybridMapping": {
"description": "Specify data that should be saved in LDAP (one of default, user, cache, site, token, or session; default to default). Note this environment only takes effect when `global.cnPersistenceType` is set to `hybrid`.",
"type": "string"
},
"cnRedisSentinelGroup": {
"description": "Redis Sentinel Group. Often set when `config.configmap.cnRedisType` is set to `SENTINEL`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisSslTruststore": {
"description": "Redis SSL truststore. Optional. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "string"
},
"cnRedisType": {
"description": "Redis service type. `STANDALONE` or `CLUSTER`. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"pattern": "^(SHARDED|STANDALONE|CLUSTER|SENTINEL)$",
"type": "string"
},
"cnRedisUrl": {
"$ref": "#/definitions/url-pattern",
"description": "Redis URL and port number <url>:<port>. Can be used when `config.configmap.cnCacheType` is set to `REDIS`."
},
"cnRedisUseSsl": {
"description": "Boolean to use SSL in Redis. Can be used when `config.configmap.cnCacheType` is set to `REDIS`.",
"type": "boolean"
},
"cnScimProtectionMode": {
"description": "SCIM protection mode OAUTH|TEST|UMA",
"pattern": "^(OAUTH|TEST|UMA)$",
"type": "string"
},
"cnSecretKubernetesSecret": {
"description": "Kubernetes secret name holding configuration keys. Used when global.configSecretAdapter is set to kubernetes which is the default.",
"pattern": "^[a-z]+$",
"type": "string"
},
"cnSqlDbDialect": {
"description": "SQL dialect",
"pattern": "^(mysql|pgsql|ldap)$",
"type": "string"
},
"cnSqlDbHost": {
"anyOf": [
{
"$ref": "#/definitions/url-pattern"
},
{
"$ref": "#/definitions/ip-pattern"
}
],
"description": "SQL server address or ip"
},
"cnSqlDbName": {
"description": "SQL server database name for Jans",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqlDbPort": {
"description": "SQL server port",
"type": "integer"
},
"cnSqlDbTimezone": {
"description": "SQL database timezone",
"pattern": "^(GMT|UTC|ECT|EET|ART|EAT|MET|NET|PLT|IST|BST|VST|CTT|JST|ACT|AET|SST|NST|MIT|HST|AST|PST|PNT|MST|CST|EST|IET|PRT|CNT|AGT|BET|CAT)$",
"type": "string"
},
"cnSqlDbUser": {
"description": "SQL database Jans username",
"pattern": "^[a-z-0-9]+$",
"type": "string"
},
"cnSqldbUserPassword": {
"$ref": "#/definitions/password",
"description": "Password for user config.configmap.cnSqlDbUser."
},
"lbAddr": {
"$ref": "#/definitions/url-pattern",
"description": "Loadbalancer address for AWS if the FQDN is not registered."
}
},
"type": "object"
},
"countryCode": {
"description": "Country code. Used for certificate creation.",
"pattern": "^[A-Z]+$",
"type": "string"
},
"email": {
"$ref": "#/definitions/email-format",
"description": "Email address of the administrator usually. Used for certificate creation."
},
"image": {
"properties": {
"repository": {
"description": "Image to use for deploying",
"type": "string"
},
"tag": {
"description": "Image tag to use for deploying.",
"pattern": "^[a-z0-9-_.]+$",
"type": "string"
}
},
"type": "object"
},
"ldapPassword": {
"$ref": "#/definitions/password",
"description": "LDAP admin password if OpennDJ is used for persistence."
},
"orgName": {
"description": "Organization name. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
},
"redisPassword": {
"$ref": "#/definitions/password",
"description": "Redis admin password if `config.configmap.cnCacheType` is set to `REDIS`"
},
"resources": {
"description": "Resource specs.",
"properties": {
"limits": {
"properties": {
"cpu": {
"description": "CPU limit.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
},
"requests": {
"properties": {
"cpu": {
"description": "CPU request.",
"pattern": "^[0-9m]+$",
"type": "string"
},
"memory": {
"description": "Memory request.",
"pattern": "^[0-9Mi]+$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"salt": {
"description": "Used for encoding/decoding sensitive data. If omitted or set to empty string, the value will be self-generated. Otherwise, a 24 alphanumeric characters are allowed as its value.",
"pattern": "^(?:[a-zA-Z0-9]{24})?$",
"type": "string"
},
"state": {
"description": "State code. Used for certificate creation.",
"pattern": "^[a-zA-Z]+$",
"type": "string"
}
},
"type": "object"
},
"config-api": {
"description": "Config Api endpoints can be used to configure the auth-server, which is an open-source OpenID Connect Provider (OP) and UMA Authorization Server (AS).",
"properties": {},
"type": "object"
},
"fido2": {
"description": "FIDO 2.0 (FIDO2) is an open authentication standard that enables leveraging common devices to authenticate to online services in both mobile and desktop environments.",
"properties": {},
"type": "object"
},
"global": {
"description": "Parameters used globally across all services helm charts.",
"properties": {
"alb": {
"properties": {
"ingress": {
"description": "Activates ALB ingress",
"type": "boolean"
}
},
"type": "object"
},
"auth-server": {
"properties": {
"appLoggers": {
"properties": {
"auditStatsLogLevel": {
"description": "jans-auth_audit.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"auditStatsLogTarget": {
"description": "jans-auth_audit.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"authLogLevel": {
"description": "jans-auth.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-auth.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"httpLogLevel": {
"description": "http_request_response level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"httpLogTarget": {
"description": "http_request_response target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-auth_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-auth_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-auth_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-auth_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-auth_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-auth_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-auth_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-auth_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"authServerServiceName": {
"description": "Name of the auth-server service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable auth-server chart. You should never set this to false.",
"type": "boolean"
}
},
"type": "object"
},
"auth-server-key-rotation": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the auth-server-key rotation cronjob chart.",
"type": "boolean"
}
},
"type": "object"
},
"awsStorageType": {
"description": "Volume stroage type if using AWS volumes.",
"pattern": "^(io1|io2|gp2|st1|sc1)$",
"type": "string"
},
"azureStorageAccountType": {
"description": "Volume storage type if using Azure disks.",
"pattern": "^(Standard_LRS|Premium_LRS|StandardSSD_LRS|UltraSSD_LRS)$",
"type": "string"
},
"azureStorageKind": {
"description": "Azure storage kind if using Azure disks",
"pattern": "^(Managed)$",
"type": "string"
},
"casa": {
"properties": {
"casaServiceName": {
"description": "Name of the casa service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the casa chart.",
"type": "boolean"
},
"ingress": {
"description": "Endpoint control",
"properties": {
"casaEnabled": {
"description": " Enable casa endpoints /casa",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"cloud": {
"properties": {
"testEnviroment": {
"description": "Boolean flag if enabled will strip resources requests and limits from all services.",
"type": "boolean"
}
},
"type": "object"
},
"cnCouchbasePasswordFile": {
"description": "The location of the Couchbase user config.configmap.cnCouchbaseUser password. The file path must end with couchbase_password.",
"pattern": ".*couchbase_password\\b.*",
"type": "string"
},
"cnCouchbaseSuperuserPasswordFile": {
"description": "The location of the Couchbase restricted user config.configmap.cnCouchbaseSuperUser password. The file path must end with couchbase_superuser_password.",
"pattern": ".*couchbase_superuser_password\\b.*",
"type": "string"
},
"cnDocumentStoreType": {
"description": "Document store type to use for shibboleth files LOCAL.",
"pattern": "^(LOCAL)$",
"type": "string"
},
"cnGoogleApplicationCredentials": {
"description": "Base64 encoded service account. The sa must have roles/secretmanager.admin to use Google secrets and roles/spanner.databaseUser to use Spanner.",
"pattern": ".*google-credentials.json\\b.*",
"type": "string"
},
"cnLdapCacertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.pem.",
"pattern": ".*opendj.pem\\b.*",
"type": "string"
},
"cnLdapCertFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.crt.",
"pattern": ".*opendj.crt\\b.*",
"type": "string"
},
"cnLdapKeyFile": {
"description": "The location of the OpenDJ certificate file. The file path must end with opendj.key.",
"pattern": ".*opendj.key\\b.*",
"type": "string"
},
"cnLdapPasswordFile": {
"description": "The location of the OpenDJ user password. The file path must end with ldap_password.",
"pattern": ".*ldap_password\\b.*",
"type": "string"
},
"cnLdapTruststoreFile": {
"description": "The location of the OpenDJ truststore file. The file path must end with opendj.pkcs12.",
"pattern": ".*opendj.pkcs12\\b.*",
"type": "string"
},
"cnLdapTruststorePasswordFile": {
"description": "The location of the OpenDJ truststore password file. The file path must end with ldap_truststore_password.",
"pattern": ".*ldap_truststore_password\\b.*",
"type": "string"
},
"cnPersistenceType": {
"description": "Persistence backend to run Janssen with ldap|couchbase|hybrid|sql|spanner.",
"pattern": "^(ldap|couchbase|hybrid|sql|spanner)$",
"type": "string"
},
"cnSqlPasswordFile": {
"description": "The location of file contains password for the SQL user config.configmap.cnSqlDbUser. The file path must end with sql_password.",
"pattern": ".*sql_password\\b.*",
"type": "string"
},
"config": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the configuration chart. This normally should always be true",
"type": "boolean"
}
},
"type": "object"
},
"config-api": {
"properties": {
"appLoggers": {
"properties": {
"configApiLogLevel": {
"description": "configapi.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"configApiLogTarget": {
"description": "configapi.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"configApiServerServiceName": {
"description": "Name of the config-api service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
},
"enabled": {
"description": "Boolean flag to enable/disable the config-api chart.",
"type": "boolean"
}
},
"type": "object"
},
"configAdapterName": {
"description": "The config backend adapter that will hold Janssen configuration layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"configSecretAdapter": {
"description": "The config backend adapter that will hold Janssen secret layer. aws|google|kubernetes",
"pattern": "^(kubernetes|google|aws)$",
"type": "string"
},
"fido2": {
"properties": {
"appLoggers": {
"properties": {
"fido2LogLevel": {
"description": "fido2.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"fido2LogTarget": {
"description": "fido2.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "fido2_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "fido2_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the fido2 chart.",
"type": "boolean"
},
"fido2ServiceName": {
"description": "Name of the fido2 service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"fqdn": {
"$ref": "#/definitions/fqdn-pattern",
"description": "Fully qualified domain name to be used for Janssen installation. This address will be used to reach Janssen services."
},
"gcePdStorageType": {
"description": "GCE storage kind if using Google disks",
"pattern": "^(pd-standard|pd-balanced|pd-ssd)$",
"type": "string"
},
"isFqdnRegistered": {
"description": "Boolean flag to enable mapping global.lbIp to global.fqdn inside pods on clouds that provide static ip for loadbalancers. On cloud that provide only addresses to the LB this flag will enable a script to actively scan config.configmap.lbAddr and update the hosts file inside the pods automatically.",
"type": "boolean"
},
"istio": {
"properties": {
"enabled": {
"description": "Boolean flag that enables using istio side cars with Janssen services.",
"type": "boolean"
},
"namespace": {
"description": "The namespace istio is deployed in. The is normally istio-system.",
"pattern": "^[a-z0-9-_/]+$",
"type": "string"
}
},
"type": "object"
},
"lbIp": {
"description": "The Loadbalancer IP created by nginx or istio on clouds that provide static IPs. This is not needed if `global.fqdn` is globally resolvable."
},
"link": {
"properties": {
"appLoggers": {
"properties": {
"ldapStatsLogLevel": {
"description": "cacherefresh_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "cacherefresh_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"linkLogLevel": {
"description": "cacherefresh.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"linkLogTarget": {
"description": "cacherefresh.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "cacherefresh_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "cacherefresh_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "cacherefresh_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "cacherefresh_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "cacherefresh_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the link chart.",
"type": "boolean"
},
"linkServiceName": {
"description": "Name of the link service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"nginx-ingress": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the nginx-ingress definitions chart.",
"type": "boolean"
}
},
"type": "object"
},
"opendj": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the OpenDJ chart.",
"type": "boolean"
},
"ldapServiceName": {
"description": "Name of the OpenDJ service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"persistence": {
"properties": {
"enabled": {
"description": "Boolean flag to enable/disable the persistence chart.",
"type": "boolean"
}
},
"type": "object"
},
"scim": {
"properties": {
"appLoggers": {
"properties": {
"authLogLevel": {
"description": "jans-scim.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"authLogTarget": {
"description": "jans-scim.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"ldapStatsLogLevel": {
"description": "jans-scim_persistence_ldap_statistics.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"ldapStatsLogTarget": {
"description": "jans-scim_persistence_ldap_statistics.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceDurationLogLevel": {
"description": "jans-scim_persistence_duration.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceDurationLogTarget": {
"description": "jans-scim_persistence_duration.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"persistenceLogLevel": {
"description": "jans-scim_persistence.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"persistenceLogTarget": {
"description": "jans-scim_persistence.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
},
"scriptLogLevel": {
"description": "jans-scim_script.log level",
"pattern": "^(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)$",
"type": "string"
},
"scriptLogTarget": {
"description": "jans-scim_script.log target",
"pattern": "^(STDOUT|FILE)$",
"type": "string"
}
},
"type": "object"
},
"enabled": {
"description": "Boolean flag to enable/disable the SCIM chart.",
"type": "boolean"
},
"scimServiceName": {
"description": "Name of the scim service. Please keep it as default.",
"pattern": "^[a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"storageClass": {
"description": "StorageClass section for OpenDJ charts. This is not currently used by the openbanking distribution. You may specify custom parameters as needed.",
"properties": {
"allowVolumeExpansion": {
"type": "boolean"
},
"allowedTopologies": {
"items": {
"type": "string"
},
"type": "array"
},
"mountOptions": {
"items": {
"type": "string"
},
"type": "array"
},
"parameters": {
"properties": {
"fsType": {
"type": "string"
},
"kind": {
"type": "string"
},
"pool": {
"type": "string"
},
"storageAccountType": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"provisioner": {
"type": "string"
},
"reclaimPolicy": {
"type": "string"
},
"volumeBindingMode": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"nginx-ingress": {
"description": "Nginx ingress definitions chart",
"properties": {},
"type": "object"
},
"opendj": {
"description": "OpenDJ is a directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.",
"properties": {},
"type": "object"
},
"persistence": {
"description": "Job to generate data and intial config for Janssen Server persistence layer.",
"properties": {},
"type": "object"
},
"scim": {
"description": "System for Cross-domain Identity Management (SCIM) version 2.0",
"properties": {},
"type": "object"
}
},
"type": "object"
} | Apache-2.0 | en |
DariuszPorowski/mkdocs-file-filter-plugin | 7350410080c937904c37b552ba4349e9a8a4229f | 2023-02-16T11:20:37 | schema-file-filter-config.json | 8 | 2024-05-27T06:48:30.20549Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Enable plugin",
"type": "boolean"
},
"enabled_on_serve": {
"default": true,
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Enable on serve",
"type": "boolean"
},
"exclude_glob": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Globs to exclude",
"type": "array"
},
"exclude_regex": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Regexes to exclude",
"type": "array"
},
"exclude_tag": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Tags to exclude",
"type": "array"
},
"filter_nav": {
"default": true,
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Remove navigation items based on excludes",
"type": "boolean"
},
"include_glob": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Globs to include",
"type": "array"
},
"include_regex": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Regexes to include",
"type": "array"
},
"include_tag": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Tags to include",
"type": "array"
},
"metadata_property": {
"default": "tags",
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Metadata property name for Tags",
"type": "string"
},
"mkdocsignore": {
"default": false,
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Enable .mkdocsignore support",
"type": "boolean"
},
"mkdocsignore_file": {
"default": ".mkdocsignore",
"format": "path",
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": ".mkdocsignore file path",
"type": "string"
},
"only_doc_pages": {
"default": false,
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Filter only documentation pages",
"type": "boolean"
}
},
"title": "mkdocs-file-filter-plugin config schema",
"type": "object"
} | MIT | en |
DariuszPorowski/mkdocs-file-filter-plugin | 302585b64b080b179db303a087c87d6abef4bd2e | 2023-05-16T01:49:20 | schema-file-filter-config.json | 8 | 2024-05-27T06:48:30.20549Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Enable plugin",
"type": "boolean"
},
"enabled_on_serve": {
"default": true,
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Enable on serve",
"type": "boolean"
},
"exclude_glob": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Globs to exclude",
"type": "array"
},
"exclude_regex": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Regexes to exclude",
"type": "array"
},
"exclude_tag": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Tags to exclude",
"type": "array"
},
"filter_nav": {
"default": true,
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Remove navigation items based on excludes",
"type": "boolean"
},
"include_glob": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Globs to include",
"type": "array"
},
"include_regex": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Regexes to include",
"type": "array"
},
"include_tag": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Tags to include",
"type": "array"
},
"metadata_property": {
"default": "tags",
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Metadata property name for Tags",
"type": "string"
},
"mkdocsignore": {
"default": false,
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Enable .mkdocsignore support",
"type": "boolean"
},
"mkdocsignore_file": {
"default": ".mkdocsignore",
"format": "path",
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": ".mkdocsignore file path",
"type": "string"
},
"only_doc_pages": {
"default": false,
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Filter only documentation pages",
"type": "boolean"
}
},
"title": "mkdocs-file-filter-plugin config schema",
"type": "object"
} | MIT | en |
DariuszPorowski/mkdocs-file-filter-plugin | 302585b64b080b179db303a087c87d6abef4bd2e | 2023-05-16T01:49:20 | schema.json | 8 | 2024-05-27T06:48:30.20549Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"oneOf": [
{
"enum": [
"file-filter"
],
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md",
"title": "mkdocs-file-filter-plugin"
},
{
"additionalProperties": false,
"properties": {
"file-filter": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "https://raw.githubusercontent.com/DariuszPorowski/mkdocs-file-filter-plugin/main/schema-file-filter-config.json",
"additionalProperties": true
}
],
"default": null,
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#configuration",
"properties": {
"config": {
"default": null,
"format": "path",
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#configuration",
"title": "External config file path",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
],
"title": "mkdocs-file-filter-plugin schema"
} | MIT | en |
DariuszPorowski/mkdocs-file-filter-plugin | 8868f7fc42ba1fdf52867b134665081449d4d0a4 | 2023-02-06T22:26:57 | schema.json | 8 | 2024-05-27T06:48:30.20549Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"oneOf": [
{
"enum": [
"file-filter"
],
"markdownDescription": "https://dariusz.porowski.dev/mkdocs-file-filter-plugin/#readme",
"title": "mkdocs-file-filter-plugin"
},
{
"additionalProperties": false,
"properties": {
"file-filter": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "https://dariusz.porowski.dev/mkdocs-file-filter-plugin/schema-config.json",
"additionalProperties": true
}
],
"default": null,
"markdownDescription": "https://dariusz.porowski.dev/mkdocs-file-filter-plugin/#configuring",
"properties": {
"config": {
"default": null,
"format": "path",
"markdownDescription": "https://dariusz.porowski.dev/mkdocs-file-filter-plugin/#configuring",
"title": "External config file path",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
],
"title": "mkdocs-file-filter-plugin schema"
} | MIT | en |
DariuszPorowski/mkdocs-file-filter-plugin | 046e042479963670754078f7073dbfa81875397b | 2023-02-09T02:37:19 | schema.json | 8 | 2024-05-27T06:48:30.20549Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"oneOf": [
{
"enum": [
"file-filter"
],
"markdownDescription": "https://dariusz.porowski.dev/mkdocs-file-filter-plugin/#readme",
"title": "mkdocs-file-filter-plugin"
},
{
"additionalProperties": false,
"properties": {
"file-filter": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "https://dariusz.porowski.dev/mkdocs-file-filter-plugin/schema-file-filter-config.json",
"additionalProperties": true
}
],
"default": null,
"markdownDescription": "https://dariusz.porowski.dev/mkdocs-file-filter-plugin/#configuring",
"properties": {
"config": {
"default": null,
"format": "path",
"markdownDescription": "https://dariusz.porowski.dev/mkdocs-file-filter-plugin/#configuring",
"title": "External config file path",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
],
"title": "mkdocs-file-filter-plugin schema"
} | MIT | en |
DariuszPorowski/mkdocs-file-filter-plugin | 50813e14b0c9cdf9572ab1c435505acb7f75d3a0 | 2023-04-07T05:22:25 | schema-file-filter-config.json | 8 | 2024-05-27T06:48:30.20549Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Enable plugin",
"type": "boolean"
},
"enabled_on_serve": {
"default": true,
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Enable on serve",
"type": "boolean"
},
"exclude_glob": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Globs to exclude",
"type": "array"
},
"exclude_regex": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Regexes to exclude",
"type": "array"
},
"exclude_tag": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Tags to exclude",
"type": "array"
},
"filter_nav": {
"default": true,
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Remove navigation items based on excludes",
"type": "boolean"
},
"include_glob": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Globs to include",
"type": "array"
},
"include_regex": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Regexes to include",
"type": "array"
},
"include_tag": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Tags to include",
"type": "array"
},
"metadata_property": {
"default": "tags",
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Metadata property name for Tags",
"type": "string"
},
"mkdocsignore": {
"default": false,
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Enable .mkdocsignore support",
"type": "boolean"
},
"mkdocsignore_file": {
"default": ".mkdocsignore",
"format": "path",
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": ".mkdocsignore file path",
"type": "string"
},
"only_doc_pages": {
"default": false,
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#usage",
"title": "Filter only documentation pages",
"type": "boolean"
}
},
"title": "mkdocs-file-filter-plugin config schema",
"type": "object"
} | MIT | en |
DariuszPorowski/mkdocs-file-filter-plugin | 7350410080c937904c37b552ba4349e9a8a4229f | 2023-02-16T11:20:37 | schema.json | 8 | 2024-05-27T06:48:30.20549Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"oneOf": [
{
"enum": [
"file-filter"
],
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md",
"title": "mkdocs-file-filter-plugin"
},
{
"additionalProperties": false,
"properties": {
"file-filter": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "https://raw.githubusercontent.com/DariuszPorowski/mkdocs-file-filter-plugin/main/schema-file-filter-config.json",
"additionalProperties": true
}
],
"default": null,
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#configuration",
"properties": {
"config": {
"default": null,
"format": "path",
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#configuration",
"title": "External config file path",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
],
"title": "mkdocs-file-filter-plugin schema"
} | MIT | en |
DariuszPorowski/mkdocs-file-filter-plugin | 046e042479963670754078f7073dbfa81875397b | 2023-02-09T02:37:19 | schema-file-filter-config.json | 8 | 2024-05-27T06:48:30.20549Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"markdownDescription": "https://dariusz.porowski.dev/mkdocs-file-filter-plugin/#usage",
"title": "Enable plugin",
"type": "boolean"
},
"enabled_on_serve": {
"default": false,
"markdownDescription": "https://dariusz.porowski.dev/mkdocs-file-filter-plugin/#usage",
"title": "Enable on serve",
"type": "boolean"
},
"exclude_glob": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://dariusz.porowski.dev/mkdocs-file-filter-plugin/#usage",
"title": "Globs to exclude",
"type": "array"
},
"exclude_regex": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://dariusz.porowski.dev/mkdocs-file-filter-plugin/#usage",
"title": "Regexes to exclude",
"type": "array"
},
"exclude_tag": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://dariusz.porowski.dev/mkdocs-file-filter-plugin/#usage",
"title": "Tags to exclude",
"type": "array"
},
"filter_nav": {
"default": true,
"markdownDescription": "https://dariusz.porowski.dev/mkdocs-file-filter-plugin/#usage",
"title": "Remove navigation items based on excludes",
"type": "boolean"
},
"include_glob": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://dariusz.porowski.dev/mkdocs-file-filter-plugin/#usage",
"title": "Globs to include",
"type": "array"
},
"include_regex": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://dariusz.porowski.dev/mkdocs-file-filter-plugin/#usage",
"title": "Regexes to include",
"type": "array"
},
"include_tag": {
"default": [],
"items": {
"type": "string"
},
"markdownDescription": "https://dariusz.porowski.dev/mkdocs-file-filter-plugin/#usage",
"title": "Tags to include",
"type": "array"
},
"metadata_property": {
"default": "tags",
"markdownDescription": "https://dariusz.porowski.dev/mkdocs-file-filter-plugin/#usage",
"title": "Metadata property name for Tags",
"type": "string"
},
"mkdocsignore": {
"default": false,
"markdownDescription": "https://dariusz.porowski.dev/mkdocs-file-filter-plugin/#usage",
"title": "Enable .mkdocsignore support",
"type": "boolean"
},
"mkdocsignore_file": {
"default": ".mkdocsignore",
"format": "path",
"markdownDescription": "https://dariusz.porowski.dev/mkdocs-file-filter-plugin/#usage",
"title": ".mkdocsignore file path",
"type": "string"
}
},
"title": "mkdocs-file-filter-plugin config schema",
"type": "object"
} | MIT | en |
DariuszPorowski/mkdocs-file-filter-plugin | 50813e14b0c9cdf9572ab1c435505acb7f75d3a0 | 2023-04-07T05:22:25 | schema.json | 8 | 2024-05-27T06:48:30.20549Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"oneOf": [
{
"enum": [
"file-filter"
],
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md",
"title": "mkdocs-file-filter-plugin"
},
{
"additionalProperties": false,
"properties": {
"file-filter": {
"additionalProperties": true,
"anyOf": [
{
"$ref": "https://raw.githubusercontent.com/DariuszPorowski/mkdocs-file-filter-plugin/main/schema-file-filter-config.json",
"additionalProperties": true
}
],
"default": null,
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#configuration",
"properties": {
"config": {
"default": null,
"format": "path",
"markdownDescription": "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md#configuration",
"title": "External config file path",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
],
"title": "mkdocs-file-filter-plugin schema"
} | MIT | en |
nlsfi/hakunapi | b56b7ea6c77bc6987c47db0a00dccd92ce0d09df | 2023-12-12T15:14:15 | src/hakunapi-jsonfg/src/test/resources/fi/nls/hakunapi/jsonfg/featurecollection.min.json | 11 | 2024-05-27T06:10:00.261155Z | {
"$id": "https://beta.schemas.opengis.net/json-fg/featurecollection.min.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "This JSON Schema is part of JSON-FG version 0.1.1",
"properties": {
"coordRefSys": {
"oneOf": [
{
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"properties": {
"epoch": {
"type": "number"
},
"href": {
"format": "uri",
"type": "string"
},
"type": {
"enum": [
"Reference"
],
"type": "string"
}
},
"required": [
"type",
"href"
],
"type": "object"
},
{
"properties": {
"type": {
"not": {
"enum": [
"Reference"
]
},
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
{
"items": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"properties": {
"epoch": {
"type": "number"
},
"href": {
"format": "uri",
"type": "string"
},
"type": {
"enum": [
"Reference"
],
"type": "string"
}
},
"required": [
"type",
"href"
],
"type": "object"
},
{
"properties": {
"type": {
"not": {
"enum": [
"Reference"
]
},
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array"
}
],
"title": "the coordRefSys member"
},
"featureType": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"title": "the featureType member"
},
"features": {
"items": {
"properties": {
"coordRefSys": {
"oneOf": [
{
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"properties": {
"epoch": {
"type": "number"
},
"href": {
"format": "uri",
"type": "string"
},
"type": {
"enum": [
"Reference"
],
"type": "string"
}
},
"required": [
"type",
"href"
],
"type": "object"
},
{
"properties": {
"type": {
"not": {
"enum": [
"Reference"
]
},
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
{
"items": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"properties": {
"epoch": {
"type": "number"
},
"href": {
"format": "uri",
"type": "string"
},
"type": {
"enum": [
"Reference"
],
"type": "string"
}
},
"required": [
"type",
"href"
],
"type": "object"
},
{
"properties": {
"type": {
"not": {
"enum": [
"Reference"
]
},
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
},
"type": "array"
}
],
"title": "the coordRefSys member"
},
"featureType": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"title": "the featureType member"
},
"geometry": {
"oneOf": [
{
"type": "null"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"Point"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Point",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"type": "array"
},
"type": {
"enum": [
"MultiPoint"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON MultiPoint",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"LineString"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON LineString",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"minItems": 2,
"type": "array"
},
"type": "array"
},
"type": {
"enum": [
"MultiLineString"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON MultiLineString",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"minItems": 4,
"type": "array"
},
"type": "array"
},
"type": {
"enum": [
"Polygon"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Polygon",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"minItems": 4,
"type": "array"
},
"type": "array"
},
"type": "array"
},
"type": {
"enum": [
"MultiPolygon"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON MultiPolygon",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"geometries": {
"items": {
"oneOf": [
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"Point"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Point",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"type": "array"
},
"type": {
"enum": [
"MultiPoint"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON MultiPoint",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"LineString"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON LineString",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"minItems": 2,
"type": "array"
},
"type": "array"
},
"type": {
"enum": [
"MultiLineString"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON MultiLineString",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"minItems": 4,
"type": "array"
},
"type": "array"
},
"type": {
"enum": [
"Polygon"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Polygon",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"minItems": 4,
"type": "array"
},
"type": "array"
},
"type": "array"
},
"type": {
"enum": [
"MultiPolygon"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON MultiPolygon",
"type": "object"
}
]
},
"type": "array"
},
"type": {
"enum": [
"GeometryCollection"
],
"type": "string"
}
},
"required": [
"type",
"geometries"
],
"title": "GeoJSON GeometryCollection",
"type": "object"
}
],
"title": "the geometry member"
},
"id": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"links": {
"items": {
"properties": {
"anchor": {
"type": "string"
},
"href": {
"format": "uri-reference",
"type": "string"
},
"hreflang": {
"type": "string"
},
"length": {
"type": "string"
},
"rel": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"rel"
],
"title": "the Link object",
"type": "object"
},
"type": "array"
},
"place": {
"oneOf": [
{
"type": "null"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"Point"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Point",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"type": "array"
},
"type": {
"enum": [
"MultiPoint"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON MultiPoint",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"LineString"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON LineString",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"minItems": 2,
"type": "array"
},
"type": "array"
},
"type": {
"enum": [
"MultiLineString"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON MultiLineString",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"minItems": 4,
"type": "array"
},
"type": "array"
},
"type": {
"enum": [
"Polygon"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Polygon",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"minItems": 4,
"type": "array"
},
"type": "array"
},
"type": "array"
},
"type": {
"enum": [
"MultiPolygon"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON MultiPolygon",
"type": "object"
},
{
"properties": {
"bbox": {
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
},
"coordinates": {
"items": {
"items": {
"items": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"minItems": 4,
"type": "array"
},
"minItems": 1,
"type": "array"
},
"minItems": 1,
"type": "array"
},
"minItems": 1,
"type": "array"
},
"type": {
"enum": [
"Polyhedron"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "JSON-FG Polyhedron",
"type": "object"
},
{
"properties": {
"bbox": {
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
},
"coordinates": {
"items": {
"items": {
"items": {
"items": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
},
"minItems": 4,
"type": "array"
},
"minItems": 1,
"type": "array"
},
"minItems": 1,
"type": "array"
},
"minItems": 1,
"type": "array"
},
"type": "array"
},
"type": {
"enum": [
"MultiPolyhedron"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "JSON-FG MultiPolyhedron",
"type": "object"
},
{
"properties": {
"base": {
"oneOf": [
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"Point"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Point",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"LineString"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON LineString",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"minItems": 4,
"type": "array"
},
"type": "array"
},
"type": {
"enum": [
"Polygon"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Polygon",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"type": "array"
},
"type": {
"enum": [
"MultiPoint"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON MultiPoint",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"minItems": 2,
"type": "array"
},
"type": "array"
},
"type": {
"enum": [
"MultiLineString"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON MultiLineString",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"minItems": 4,
"type": "array"
},
"type": "array"
},
"type": "array"
},
"type": {
"enum": [
"MultiPolygon"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON MultiPolygon",
"type": "object"
}
]
},
"bbox": {
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
},
"lower": {
"type": "number"
},
"type": {
"enum": [
"Prism"
],
"type": "string"
},
"upper": {
"type": "number"
}
},
"required": [
"type",
"base",
"upper"
],
"title": "JSON-FG Prism",
"type": "object"
},
{
"properties": {
"bbox": {
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
},
"prisms": {
"items": {
"properties": {
"base": {
"oneOf": [
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"Point"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Point",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"minItems": 2,
"type": "array"
},
"type": {
"enum": [
"LineString"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON LineString",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"minItems": 4,
"type": "array"
},
"type": "array"
},
"type": {
"enum": [
"Polygon"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON Polygon",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"type": "array"
},
"type": {
"enum": [
"MultiPoint"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON MultiPoint",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"minItems": 2,
"type": "array"
},
"type": "array"
},
"type": {
"enum": [
"MultiLineString"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON MultiLineString",
"type": "object"
},
{
"properties": {
"bbox": {
"oneOf": [
{
"items": {
"type": "number"
},
"maxItems": 4,
"minItems": 4,
"type": "array"
},
{
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
}
]
},
"coordinates": {
"items": {
"items": {
"items": {
"items": {
"type": "number"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
},
"minItems": 4,
"type": "array"
},
"type": "array"
},
"type": "array"
},
"type": {
"enum": [
"MultiPolygon"
],
"type": "string"
}
},
"required": [
"type",
"coordinates"
],
"title": "GeoJSON MultiPolygon",
"type": "object"
}
]
},
"bbox": {
"items": {
"type": "number"
},
"maxItems": 6,
"minItems": 6,
"type": "array"
},
"lower": {
"type": "number"
},
"type": {
"enum": [
"Prism"
],
"type": "string"
},
"upper": {
"type": "number"
}
},
"required": [
"type",
"base",
"upper"
],
"title": "JSON-FG Prism",
"type": "object"
},
"type": "array"
},
"type": {
"enum": [
"MultiPrism"
],
"type": "string"
}
},
"required": [
"type",
"prisms"
],
"title": "JSON-FG Multi-Prism",
"type": "object"
},
{
"properties": {
"type": {
"not": {
"enum": [
"Point",
"MultiPoint",
"LineString",
"MultiLineString",
"Polygon",
"MultiPolygon",
"Polyhedron",
"MultiPolyhedron",
"Prism",
"MultiPrism",
"GeometryCollection"
]
},
"type": "string"
}
},
"required": [
"type"
],
"title": "A custom geometry object",
"type": "object"
}
],
"title": "the place member"
},
"properties": {
"oneOf": [
{
"type": "null"
},
{
"type": "object"
}
]
},
"time": {
"oneOf": [
{
"type": "null"
},
{
"properties": {
"date": {
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"type": "string"
},
"interval": {
"items": {
"oneOf": [
{
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"type": "string"
},
{
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?Z$",
"type": "string"
},
{
"enum": [
".."
],
"type": "string"
}
]
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"timestamp": {
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?Z$",
"type": "string"
}
},
"type": "object"
}
],
"title": "the time member"
},
"type": {
"enum": [
"Feature"
],
"type": "string"
}
},
"required": [
"type",
"time",
"place",
"geometry",
"properties"
],
"title": "a JSON-FG Feature",
"type": "object"
},
"type": "array"
},
"geometryDimension": {
"maximum": 3,
"minimum": 0,
"type": "integer"
},
"links": {
"items": {
"properties": {
"anchor": {
"type": "string"
},
"href": {
"format": "uri-reference",
"type": "string"
},
"hreflang": {
"type": "string"
},
"length": {
"type": "string"
},
"rel": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"href",
"rel"
],
"title": "the Link object",
"type": "object"
},
"type": "array"
},
"type": {
"enum": [
"FeatureCollection"
],
"type": "string"
}
},
"required": [
"type",
"features"
],
"title": "a JSON-FG Feature Collection",
"type": "object"
} | MIT | en |
pixee/codemodder-specs | 11c3ce490acbe8bb3e562ce7381511b88b3e8ef0 | 2024-03-08T15:14:59 | codetf.schema.json | 14 | 2024-05-27T08:57:42.919452Z | {
"$id": "https://pixee.ai/codetf.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"change": {
"properties": {
"description": {
"description": "A human-readable description of the change",
"type": "string"
},
"diffSide": {
"description": "The side of the diff that the change is on. 'right' indicates that the lineNumber and description correspond to a position in the new or modified code. 'left' indicates these fields correspond to a position in the original code. Descriptions of the change itself should generally use 'right', except in cases where the only change is a deletion. In contrast, 'left' can be used to describe the original problem being fixed.",
"enum": [
"left",
"right",
"LEFT",
"RIGHT"
],
"type": "string"
},
"lineNumber": {
"description": "The line number that was changed",
"type": "integer"
},
"packageActions": {
"description": "The package actions that were needed to support changes to the file",
"items": {
"$ref": "#/definitions/packageAction"
},
"type": "array"
},
"properties": {
"additionalProperties": true,
"description": "Vendor-specific properties to help storytelling",
"type": "object"
}
},
"required": [
"lineNumber",
"diffSide"
],
"type": "object"
},
"changeset": {
"properties": {
"changes": {
"items": {
"$ref": "#/definitions/change"
},
"minItems": 1,
"type": "array"
},
"diff": {
"description": "The unified diff format of the changes made to the file",
"type": "string"
},
"path": {
"description": "The path of the file (relative to the directory) that was changed",
"type": "string"
}
},
"required": [
"path",
"diff",
"changes"
],
"type": "object"
},
"detectionTool": {
"additionalProperties": true,
"properties": {
"name": {
"description": "Name of the tool that detected the issue",
"type": "string"
},
"ruleDescription": {
"description": "Short description of the tool vendor rule that detected the issue",
"type": "string"
},
"ruleId": {
"description": "ID of the tool vendor rule that detected the issue",
"type": "string"
}
},
"required": [
"name",
"ruleId"
],
"type": "object"
},
"packageAction": {
"properties": {
"action": {
"description": "One of 'add' or 'remove'",
"enum": [
"add",
"remove",
"ADD",
"REMOVE"
],
"type": "string"
},
"package": {
"description": "The package that was added or removed",
"type": "string"
},
"result": {
"description": "One of 'completed', 'failed', or 'skipped'",
"enum": [
"completed",
"failed",
"skipped",
"COMPLETED",
"FAILED",
"SKIPPED"
],
"type": "string"
}
},
"required": [
"action",
"result",
"package"
],
"type": "object"
},
"reference": {
"properties": {
"description": {
"description": "A description of the reference",
"type": "string"
},
"url": {
"description": "The URL of the reference",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"result": {
"properties": {
"changeset": {
"description": "The changes for a given codemod",
"items": {
"$ref": "#/definitions/changeset"
},
"minItems": 0,
"type": "array"
},
"codemod": {
"description": "ID of the transformation that was applied",
"type": "string"
},
"description": {
"description": "A longer description of the changes made",
"type": "string"
},
"detectionTool": {
"$ref": "#/definitions/detectionTool",
"description": "Metadata about the tool that detected the issue"
},
"failedFiles": {
"description": "A set of file paths for files that the tool failed to parse or transform",
"items": {
"type": "string"
},
"type": "array"
},
"properties": {
"additionalProperties": true,
"description": "Vendor-specific properties to help storytelling",
"type": "object"
},
"references": {
"items": {
"$ref": "#/definitions/reference"
},
"type": "array"
},
"summary": {
"description": "A short phrase describing the changes made",
"type": "string"
}
},
"required": [
"codemod",
"summary",
"description",
"changeset"
],
"type": "object"
},
"run": {
"properties": {
"commandLine": {
"description": "The command line used to re-create this run",
"type": "string"
},
"directory": {
"description": "The location on disk of the code directory being scanned",
"type": "string"
},
"elapsed": {
"description": "How long, in miliseconds, the analysis took to execute",
"type": "integer"
},
"projectName": {
"description": "Name of the project that was analyzed",
"type": "string"
},
"sarifs": {
"items": {
"$ref": "#/definitions/sarif"
},
"type": "array"
},
"tool": {
"description": "Name of the tool that produced the CodeTF results",
"type": "string"
},
"vendor": {
"description": "Name of the organization that produced the tool",
"type": "string"
},
"version": {
"description": "Version of the tool that produced the CodeTF results",
"type": "string"
}
},
"required": [
"vendor",
"tool",
"version",
"commandLine",
"elapsed",
"directory"
],
"type": "object"
},
"sarif": {
"properties": {
"artifact": {
"description": "The file containing the SARIF or other input",
"type": "string"
},
"sha1": {
"description": "SHA1 hash representing the artifact",
"type": "string"
}
},
"required": [
"artifact",
"sha1"
],
"type": "object"
}
},
"description": "A format for representing the results of code transformations",
"properties": {
"results": {
"description": "The results of the code transformations that were applied during analysis",
"items": {
"$ref": "#/definitions/result"
},
"minItems": 0,
"type": "array"
},
"run": {
"$ref": "#/definitions/run",
"description": "Metadata about the run that produced the results"
}
},
"required": [
"run",
"results"
],
"title": "Code Transformation Format (CodeTF)",
"type": "object"
} | MIT | en |
pixee/codemodder-specs | c42457d566278c8f94bc7080c97f10e1740158b9 | 2024-03-08T15:14:59 | codetf.schema.json | 14 | 2024-05-27T08:57:42.919452Z | {
"$id": "https://pixee.ai/codetf.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"change": {
"properties": {
"description": {
"description": "A human-readable description of the change",
"type": "string"
},
"diffSide": {
"description": "The side of the diff that the change is on. 'right' indicates that the lineNumber and description correspond to a position in the new or modified code. 'left' indicates these fields correspond to a position in the original code. Descriptions of the change itself should generally use 'right', except in cases where the only change is a deletion. In contrast, 'left' can be used to describe the original problem being fixed.",
"enum": [
"left",
"right",
"LEFT",
"RIGHT"
],
"type": "string"
},
"lineNumber": {
"description": "The line number that was changed",
"type": [
"integer",
"string"
]
},
"packageActions": {
"description": "The package actions that were needed to support changes to the file",
"items": {
"$ref": "#/definitions/packageAction"
},
"type": "array"
},
"properties": {
"additionalProperties": true,
"description": "Vendor-specific properties to help storytelling",
"type": "object"
}
},
"required": [
"lineNumber",
"diffSide"
],
"type": "object"
},
"changeset": {
"properties": {
"changes": {
"items": {
"$ref": "#/definitions/change"
},
"minItems": 1,
"type": "array"
},
"diff": {
"description": "The unified diff format of the changes made to the file",
"type": "string"
},
"path": {
"description": "The path of the file (relative to the directory) that was changed",
"type": "string"
}
},
"required": [
"path",
"diff",
"changes"
],
"type": "object"
},
"detectionTool": {
"additionalProperties": true,
"properties": {
"name": {
"description": "Name of the tool that detected the issue",
"type": "string"
},
"ruleDescription": {
"description": "Short description of the tool vendor rule that detected the issue",
"type": "string"
},
"ruleId": {
"description": "ID of the tool vendor rule that detected the issue",
"type": "string"
}
},
"required": [
"name",
"ruleId"
],
"type": "object"
},
"packageAction": {
"properties": {
"action": {
"description": "One of 'add' or 'remove'",
"enum": [
"add",
"remove",
"ADD",
"REMOVE"
],
"type": "string"
},
"package": {
"description": "The package that was added or removed",
"type": "string"
},
"result": {
"description": "One of 'completed', 'failed', or 'skipped'",
"enum": [
"completed",
"failed",
"skipped",
"COMPLETED",
"FAILED",
"SKIPPED"
],
"type": "string"
}
},
"required": [
"action",
"result",
"package"
],
"type": "object"
},
"reference": {
"properties": {
"description": {
"description": "A description of the reference",
"type": "string"
},
"url": {
"description": "The URL of the reference",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"result": {
"properties": {
"changeset": {
"description": "The changes for a given codemod",
"items": {
"$ref": "#/definitions/changeset"
},
"minItems": 0,
"type": "array"
},
"codemod": {
"description": "ID of the transformation that was applied",
"type": "string"
},
"description": {
"description": "A longer description of the changes made",
"type": "string"
},
"detectionTool": {
"$ref": "#/definitions/detectionTool",
"description": "Metadata about the tool that detected the issue"
},
"failedFiles": {
"description": "A set of file paths for files that the tool failed to parse or transform",
"items": {
"type": "string"
},
"type": "array"
},
"properties": {
"additionalProperties": true,
"description": "Vendor-specific properties to help storytelling",
"type": "object"
},
"references": {
"items": {
"$ref": "#/definitions/reference"
},
"type": "array"
},
"summary": {
"description": "A short phrase describing the changes made",
"type": "string"
}
},
"required": [
"codemod",
"summary",
"description",
"changeset"
],
"type": "object"
},
"run": {
"properties": {
"commandLine": {
"description": "The command line used to re-create this run",
"type": "string"
},
"directory": {
"description": "The location on disk of the code directory being scanned",
"type": "string"
},
"elapsed": {
"description": "How long, in miliseconds, the analysis took to execute",
"type": [
"integer",
"string"
]
},
"projectName": {
"description": "Name of the project that was analyzed",
"type": "string"
},
"sarifs": {
"items": {
"$ref": "#/definitions/sarif"
},
"type": "array"
},
"tool": {
"description": "Name of the tool that produced the CodeTF results",
"type": "string"
},
"vendor": {
"description": "Name of the organization that produced the tool",
"type": "string"
},
"version": {
"description": "Version of the tool that produced the CodeTF results",
"type": "string"
}
},
"required": [
"vendor",
"tool",
"version",
"commandLine",
"elapsed",
"directory"
],
"type": "object"
},
"sarif": {
"properties": {
"artifact": {
"description": "The file containing the SARIF or other input",
"type": "string"
},
"sha1": {
"description": "SHA1 hash representing the artifact",
"type": "string"
}
},
"required": [
"artifact",
"sha1"
],
"type": "object"
}
},
"description": "A format for representing the results of code transformations",
"properties": {
"results": {
"description": "The results of the code transformations that were applied during analysis",
"items": {
"$ref": "#/definitions/result"
},
"minItems": 0,
"type": "array"
},
"run": {
"$ref": "#/definitions/run",
"description": "Metadata about the run that produced the results"
}
},
"required": [
"run",
"results"
],
"title": "Code Transformation Format (CodeTF)",
"type": "object"
} | MIT | en |
pixee/codemodder-specs | c1233b3de0df1ad2bd2daf1a0bed3a68a7bc89de | 2024-04-24T15:30:19 | codetf.schema.json | 14 | 2024-05-27T08:57:42.919452Z | {
"$id": "https://pixee.ai/codetf.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"ai": {
"properties": {
"model": {
"description": "Name of the model used to generate this fix",
"type": "string"
},
"provider": {
"description": "Name of the AI provider used to generate this fix",
"type": "string"
},
"tokens": {
"description": "Total number of tokens used to generate the fix",
"type": "integer"
}
},
"type": "object"
},
"change": {
"properties": {
"description": {
"description": "A human-readable description of the change",
"type": "string"
},
"diffSide": {
"description": "The side of the diff that the change is on. 'right' indicates that the lineNumber and description correspond to a position in the new or modified code. 'left' indicates these fields correspond to a position in the original code. Descriptions of the change itself should generally use 'right', except in cases where the only change is a deletion. In contrast, 'left' can be used to describe the original problem being fixed.",
"enum": [
"left",
"right",
"LEFT",
"RIGHT"
],
"type": "string"
},
"finding": {
"$ref": "#/definitions/detector/fixedFinding",
"description": "The finding that was fixed at this location"
},
"lineNumber": {
"description": "The line number that was changed",
"type": [
"integer",
"string"
]
},
"packageActions": {
"description": "The package actions that were needed to support changes to the file",
"items": {
"$ref": "#/definitions/packageAction"
},
"type": "array"
},
"properties": {
"additionalProperties": true,
"description": "Vendor-specific properties to help storytelling",
"type": "object"
}
},
"required": [
"lineNumber",
"diffSide"
],
"type": "object"
},
"changeset": {
"properties": {
"ai": {
"$ref": "#/definitions/ai",
"description": "Metadata about AI tool used to generate the fix"
},
"changes": {
"items": {
"$ref": "#/definitions/change"
},
"minItems": 1,
"type": "array"
},
"diff": {
"description": "The unified diff format of the changes made to the file",
"type": "string"
},
"path": {
"description": "The path of the file (relative to the directory) that was changed",
"type": "string"
}
},
"required": [
"path",
"diff",
"changes"
],
"type": "object"
},
"detectionTool": {
"additionalProperties": true,
"properties": {
"name": {
"description": "Name of the tool that detected the issue",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"detector": {
"fixedFinding": {
"additionalProperties": true,
"properties": {
"id": {
"description": "A unique identifier for the finding (e.g. 'guid' from SARIF)",
"type": "string"
},
"rule": {
"$ref": "#/definitions/detector/rule",
"description": "The rule that detected the issue"
}
},
"required": [
"id",
"rule"
],
"type": "object"
},
"rule": {
"additionalProperties": false,
"properties": {
"id": {
"description": "The ID of the rule",
"type": "string"
},
"name": {
"description": "The name of the rule. Potentially the same as the ID, but more human-readable",
"type": "string"
},
"url": {
"description": "Link to the rule documentation",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"unfixedFinding": {
"additionalProperties": true,
"properties": {
"id": {
"description": "A unique identifier for the finding (e.g. 'guid' from SARIF)",
"type": "string"
},
"lineNumber": {
"description": "The line number that was not fixed",
"type": "integer"
},
"path": {
"description": "The path of the file (relative to the directory) that was not fixed",
"type": "string"
},
"reason": {
"description": "A human-readable description of the reason the file was not fixed",
"type": "string"
},
"rule": {
"$ref": "#/definitions/detector/rule",
"description": "The rule that detected the issue"
}
},
"required": [
"id",
"rule",
"path",
"reason"
],
"type": "object"
}
},
"packageAction": {
"properties": {
"action": {
"description": "One of 'add' or 'remove'",
"enum": [
"add",
"remove",
"ADD",
"REMOVE"
],
"type": "string"
},
"package": {
"description": "The package that was added or removed",
"type": "string"
},
"result": {
"description": "One of 'completed', 'failed', or 'skipped'",
"enum": [
"completed",
"failed",
"skipped",
"COMPLETED",
"FAILED",
"SKIPPED"
],
"type": "string"
}
},
"required": [
"action",
"result",
"package"
],
"type": "object"
},
"reference": {
"properties": {
"description": {
"description": "A description of the reference",
"type": "string"
},
"url": {
"description": "The URL of the reference",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"result": {
"properties": {
"changeset": {
"description": "The changes for a given codemod",
"items": {
"$ref": "#/definitions/changeset"
},
"minItems": 0,
"type": "array"
},
"codemod": {
"description": "ID of the transformation that was applied",
"type": "string"
},
"description": {
"description": "A longer description of the changes made",
"type": "string"
},
"detectionTool": {
"$ref": "#/definitions/detectionTool",
"description": "Metadata about the tool that detected the issue"
},
"failedFiles": {
"description": "A set of file paths for files that the tool failed to parse or transform",
"items": {
"type": "string"
},
"type": "array"
},
"properties": {
"additionalProperties": true,
"description": "Vendor-specific properties to help storytelling",
"type": "object"
},
"references": {
"items": {
"$ref": "#/definitions/reference"
},
"type": "array"
},
"summary": {
"description": "A short phrase describing the changes made",
"type": "string"
},
"unfixed": {
"description": "A set of file paths for files that the tool failed to fix",
"items": {
"$ref": "#/definitions/unfixedFinding"
},
"type": "array"
}
},
"required": [
"codemod",
"summary",
"description",
"changeset"
],
"type": "object"
},
"run": {
"properties": {
"commandLine": {
"description": "The command line used to re-create this run",
"type": "string"
},
"directory": {
"description": "The location on disk of the code directory being scanned",
"type": "string"
},
"elapsed": {
"description": "How long, in miliseconds, the analysis took to execute",
"type": [
"integer",
"string"
]
},
"projectName": {
"description": "Name of the project that was analyzed",
"type": "string"
},
"sarifs": {
"items": {
"$ref": "#/definitions/sarif"
},
"type": "array"
},
"tool": {
"description": "Name of the tool that produced the CodeTF results",
"type": "string"
},
"vendor": {
"description": "Name of the organization that produced the tool",
"type": "string"
},
"version": {
"description": "Version of the tool that produced the CodeTF results",
"type": "string"
}
},
"required": [
"vendor",
"tool",
"version",
"commandLine",
"elapsed",
"directory"
],
"type": "object"
},
"sarif": {
"properties": {
"artifact": {
"description": "The file containing the SARIF or other input",
"type": "string"
},
"sha1": {
"description": "SHA1 hash representing the artifact",
"type": "string"
}
},
"required": [
"artifact",
"sha1"
],
"type": "object"
}
},
"description": "A format for representing the results of code transformations",
"properties": {
"results": {
"description": "The results of the code transformations that were applied during analysis",
"items": {
"$ref": "#/definitions/result"
},
"minItems": 0,
"type": "array"
},
"run": {
"$ref": "#/definitions/run",
"description": "Metadata about the run that produced the results"
}
},
"required": [
"run",
"results"
],
"title": "Code Transformation Format (CodeTF)",
"type": "object"
} | MIT | en |
pixee/codemodder-specs | 6657b2bf211e6cd502766048b4785656b4f0c741 | 2024-05-10T13:38:04 | codetf.schema.json | 14 | 2024-05-27T08:57:42.919452Z | {
"$id": "https://pixee.ai/codetf.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"ai": {
"properties": {
"model": {
"description": "Name of the model used to generate this fix",
"type": "string"
},
"provider": {
"description": "Name of the AI provider used to generate this fix",
"type": "string"
},
"tokens": {
"description": "Total number of tokens used to generate the fix",
"type": "integer"
}
},
"type": "object"
},
"change": {
"properties": {
"description": {
"description": "A human-readable description of the change",
"type": "string"
},
"diffSide": {
"description": "The side of the diff that the change is on. 'right' indicates that the lineNumber and description correspond to a position in the new or modified code. 'left' indicates these fields correspond to a position in the original code. Descriptions of the change itself should generally use 'right', except in cases where the only change is a deletion. In contrast, 'left' can be used to describe the original problem being fixed.",
"enum": [
"left",
"right",
"LEFT",
"RIGHT"
],
"type": "string"
},
"findings": {
"description": "List of findings that were fixed at this location",
"items": {
"$ref": "#/definitions/detector/fixedFinding"
},
"type": "array"
},
"lineNumber": {
"description": "The line number that was changed",
"type": [
"integer",
"string"
]
},
"packageActions": {
"description": "The package actions that were needed to support changes to the file",
"items": {
"$ref": "#/definitions/packageAction"
},
"type": "array"
},
"properties": {
"additionalProperties": true,
"description": "Vendor-specific properties to help storytelling",
"type": "object"
}
},
"required": [
"lineNumber",
"diffSide"
],
"type": "object"
},
"changeset": {
"properties": {
"ai": {
"$ref": "#/definitions/ai",
"description": "Metadata about AI tool used to generate the fix"
},
"changes": {
"items": {
"$ref": "#/definitions/change"
},
"minItems": 1,
"type": "array"
},
"diff": {
"description": "The unified diff format of the changes made to the file",
"type": "string"
},
"path": {
"description": "The path of the file (relative to the directory) that was changed",
"type": "string"
}
},
"required": [
"path",
"diff",
"changes"
],
"type": "object"
},
"detectionTool": {
"additionalProperties": true,
"properties": {
"name": {
"description": "Name of the tool that detected the issue",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"detector": {
"fixedFinding": {
"additionalProperties": true,
"properties": {
"id": {
"description": "A unique identifier for the finding (e.g. 'guid' from SARIF)",
"type": "string"
},
"rule": {
"$ref": "#/definitions/detector/rule",
"description": "The rule that detected the issue"
}
},
"required": [
"id",
"rule"
],
"type": "object"
},
"rule": {
"additionalProperties": false,
"properties": {
"id": {
"description": "The ID of the rule",
"type": "string"
},
"name": {
"description": "The name of the rule. Potentially the same as the ID, but more human-readable",
"type": "string"
},
"url": {
"description": "Link to the rule documentation",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"unfixedFinding": {
"additionalProperties": true,
"properties": {
"id": {
"description": "A unique identifier for the finding (e.g. 'guid' from SARIF)",
"type": "string"
},
"lineNumber": {
"description": "The line number that was not fixed",
"type": "integer"
},
"path": {
"description": "The path of the file (relative to the directory) that was not fixed",
"type": "string"
},
"reason": {
"description": "A human-readable description of the reason the file was not fixed",
"type": "string"
},
"rule": {
"$ref": "#/definitions/detector/rule",
"description": "The rule that detected the issue"
}
},
"required": [
"id",
"rule",
"path",
"reason"
],
"type": "object"
}
},
"packageAction": {
"properties": {
"action": {
"description": "One of 'add' or 'remove'",
"enum": [
"add",
"remove",
"ADD",
"REMOVE"
],
"type": "string"
},
"package": {
"description": "The package that was added or removed",
"type": "string"
},
"result": {
"description": "One of 'completed', 'failed', or 'skipped'",
"enum": [
"completed",
"failed",
"skipped",
"COMPLETED",
"FAILED",
"SKIPPED"
],
"type": "string"
}
},
"required": [
"action",
"result",
"package"
],
"type": "object"
},
"reference": {
"properties": {
"description": {
"description": "A description of the reference",
"type": "string"
},
"url": {
"description": "The URL of the reference",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"result": {
"properties": {
"changeset": {
"description": "The changes for a given codemod",
"items": {
"$ref": "#/definitions/changeset"
},
"minItems": 0,
"type": "array"
},
"codemod": {
"description": "ID of the transformation that was applied",
"type": "string"
},
"description": {
"description": "A longer description of the changes made",
"type": "string"
},
"detectionTool": {
"$ref": "#/definitions/detectionTool",
"description": "Metadata about the tool that detected the issue"
},
"failedFiles": {
"description": "A set of file paths for files that the tool failed to parse or transform",
"items": {
"type": "string"
},
"type": "array"
},
"properties": {
"additionalProperties": true,
"description": "Vendor-specific properties to help storytelling",
"type": "object"
},
"references": {
"items": {
"$ref": "#/definitions/reference"
},
"type": "array"
},
"summary": {
"description": "A short phrase describing the changes made",
"type": "string"
},
"unfixed": {
"description": "A set of file paths for files that the tool failed to fix",
"items": {
"$ref": "#/definitions/unfixedFinding"
},
"type": "array"
}
},
"required": [
"codemod",
"summary",
"description",
"changeset"
],
"type": "object"
},
"run": {
"properties": {
"commandLine": {
"description": "The command line used to re-create this run",
"type": "string"
},
"directory": {
"description": "The location on disk of the code directory being scanned",
"type": "string"
},
"elapsed": {
"description": "How long, in miliseconds, the analysis took to execute",
"type": [
"integer",
"string"
]
},
"projectName": {
"description": "Name of the project that was analyzed",
"type": "string"
},
"sarifs": {
"items": {
"$ref": "#/definitions/sarif"
},
"type": "array"
},
"tool": {
"description": "Name of the tool that produced the CodeTF results",
"type": "string"
},
"vendor": {
"description": "Name of the organization that produced the tool",
"type": "string"
},
"version": {
"description": "Version of the tool that produced the CodeTF results",
"type": "string"
}
},
"required": [
"vendor",
"tool",
"version",
"commandLine",
"elapsed",
"directory"
],
"type": "object"
},
"sarif": {
"properties": {
"artifact": {
"description": "The file containing the SARIF or other input",
"type": "string"
},
"sha1": {
"description": "SHA1 hash representing the artifact",
"type": "string"
}
},
"required": [
"artifact",
"sha1"
],
"type": "object"
}
},
"description": "A format for representing the results of code transformations",
"properties": {
"results": {
"description": "The results of the code transformations that were applied during analysis",
"items": {
"$ref": "#/definitions/result"
},
"minItems": 0,
"type": "array"
},
"run": {
"$ref": "#/definitions/run",
"description": "Metadata about the run that produced the results"
}
},
"required": [
"run",
"results"
],
"title": "Code Transformation Format (CodeTF)",
"type": "object"
} | MIT | en |
pixee/codemodder-specs | d54e1e906ac552ae748a15c03c4245780cc1be2e | 2024-04-09T13:32:05 | codetf.schema.json | 14 | 2024-05-27T08:57:42.919452Z | {
"$id": "https://pixee.ai/codetf.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"change": {
"properties": {
"description": {
"description": "A human-readable description of the change",
"type": "string"
},
"diffSide": {
"description": "The side of the diff that the change is on. 'right' indicates that the lineNumber and description correspond to a position in the new or modified code. 'left' indicates these fields correspond to a position in the original code. Descriptions of the change itself should generally use 'right', except in cases where the only change is a deletion. In contrast, 'left' can be used to describe the original problem being fixed.",
"enum": [
"left",
"right",
"LEFT",
"RIGHT"
],
"type": "string"
},
"finding": {
"$ref": "#/definitions/detector/fixedFinding",
"description": "The finding that was fixed at this location"
},
"lineNumber": {
"description": "The line number that was changed",
"type": [
"integer",
"string"
]
},
"packageActions": {
"description": "The package actions that were needed to support changes to the file",
"items": {
"$ref": "#/definitions/packageAction"
},
"type": "array"
},
"properties": {
"additionalProperties": true,
"description": "Vendor-specific properties to help storytelling",
"type": "object"
}
},
"required": [
"lineNumber",
"diffSide"
],
"type": "object"
},
"changeset": {
"properties": {
"changes": {
"items": {
"$ref": "#/definitions/change"
},
"minItems": 1,
"type": "array"
},
"diff": {
"description": "The unified diff format of the changes made to the file",
"type": "string"
},
"path": {
"description": "The path of the file (relative to the directory) that was changed",
"type": "string"
}
},
"required": [
"path",
"diff",
"changes"
],
"type": "object"
},
"detectionTool": {
"additionalProperties": true,
"properties": {
"name": {
"description": "Name of the tool that detected the issue",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"detector": {
"fixedFinding": {
"additionalProperties": true,
"properties": {
"id": {
"description": "A unique identifier for the finding (e.g. 'guid' from SARIF)",
"type": "string"
},
"rule": {
"$ref": "#/definitions/detector/rule",
"description": "The rule that detected the issue"
}
},
"required": [
"id",
"rule"
],
"type": "object"
},
"rule": {
"additionalProperties": false,
"properties": {
"id": {
"description": "The ID of the rule",
"type": "string"
},
"name": {
"description": "The name of the rule. Potentially the same as the ID, but more human-readable",
"type": "string"
},
"url": {
"description": "Link to the rule documentation",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"unfixedFinding": {
"additionalProperties": true,
"properties": {
"id": {
"description": "A unique identifier for the finding (e.g. 'guid' from SARIF)",
"type": "string"
},
"lineNumber": {
"description": "The line number that was not fixed",
"type": "integer"
},
"path": {
"description": "The path of the file (relative to the directory) that was not fixed",
"type": "string"
},
"reason": {
"description": "A human-readable description of the reason the file was not fixed",
"type": "string"
},
"rule": {
"$ref": "#/definitions/detector/rule",
"description": "The rule that detected the issue"
}
},
"required": [
"id",
"rule",
"path",
"reason"
],
"type": "object"
}
},
"packageAction": {
"properties": {
"action": {
"description": "One of 'add' or 'remove'",
"enum": [
"add",
"remove",
"ADD",
"REMOVE"
],
"type": "string"
},
"package": {
"description": "The package that was added or removed",
"type": "string"
},
"result": {
"description": "One of 'completed', 'failed', or 'skipped'",
"enum": [
"completed",
"failed",
"skipped",
"COMPLETED",
"FAILED",
"SKIPPED"
],
"type": "string"
}
},
"required": [
"action",
"result",
"package"
],
"type": "object"
},
"reference": {
"properties": {
"description": {
"description": "A description of the reference",
"type": "string"
},
"url": {
"description": "The URL of the reference",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"result": {
"properties": {
"changeset": {
"description": "The changes for a given codemod",
"items": {
"$ref": "#/definitions/changeset"
},
"minItems": 0,
"type": "array"
},
"codemod": {
"description": "ID of the transformation that was applied",
"type": "string"
},
"description": {
"description": "A longer description of the changes made",
"type": "string"
},
"detectionTool": {
"$ref": "#/definitions/detectionTool",
"description": "Metadata about the tool that detected the issue"
},
"failedFiles": {
"description": "A set of file paths for files that the tool failed to parse or transform",
"items": {
"type": "string"
},
"type": "array"
},
"properties": {
"additionalProperties": true,
"description": "Vendor-specific properties to help storytelling",
"type": "object"
},
"references": {
"items": {
"$ref": "#/definitions/reference"
},
"type": "array"
},
"summary": {
"description": "A short phrase describing the changes made",
"type": "string"
},
"unfixed": {
"description": "A set of file paths for files that the tool failed to fix",
"items": {
"$ref": "#/definitions/unfixedFinding"
},
"type": "array"
}
},
"required": [
"codemod",
"summary",
"description",
"changeset"
],
"type": "object"
},
"run": {
"properties": {
"commandLine": {
"description": "The command line used to re-create this run",
"type": "string"
},
"directory": {
"description": "The location on disk of the code directory being scanned",
"type": "string"
},
"elapsed": {
"description": "How long, in miliseconds, the analysis took to execute",
"type": [
"integer",
"string"
]
},
"projectName": {
"description": "Name of the project that was analyzed",
"type": "string"
},
"sarifs": {
"items": {
"$ref": "#/definitions/sarif"
},
"type": "array"
},
"tool": {
"description": "Name of the tool that produced the CodeTF results",
"type": "string"
},
"vendor": {
"description": "Name of the organization that produced the tool",
"type": "string"
},
"version": {
"description": "Version of the tool that produced the CodeTF results",
"type": "string"
}
},
"required": [
"vendor",
"tool",
"version",
"commandLine",
"elapsed",
"directory"
],
"type": "object"
},
"sarif": {
"properties": {
"artifact": {
"description": "The file containing the SARIF or other input",
"type": "string"
},
"sha1": {
"description": "SHA1 hash representing the artifact",
"type": "string"
}
},
"required": [
"artifact",
"sha1"
],
"type": "object"
}
},
"description": "A format for representing the results of code transformations",
"properties": {
"results": {
"description": "The results of the code transformations that were applied during analysis",
"items": {
"$ref": "#/definitions/result"
},
"minItems": 0,
"type": "array"
},
"run": {
"$ref": "#/definitions/run",
"description": "Metadata about the run that produced the results"
}
},
"required": [
"run",
"results"
],
"title": "Code Transformation Format (CodeTF)",
"type": "object"
} | MIT | en |
pixee/codemodder-specs | 565fe1bd1b1f396137605d36d4b0e65c50fdac03 | 2024-03-12T15:25:58 | codetf.schema.json | 14 | 2024-05-27T08:57:42.919452Z | {
"$id": "https://pixee.ai/codetf.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"change": {
"properties": {
"description": {
"description": "A human-readable description of the change",
"type": "string"
},
"diffSide": {
"description": "The side of the diff that the change is on. 'right' indicates that the lineNumber and description correspond to a position in the new or modified code. 'left' indicates these fields correspond to a position in the original code. Descriptions of the change itself should generally use 'right', except in cases where the only change is a deletion. In contrast, 'left' can be used to describe the original problem being fixed.",
"enum": [
"left",
"right",
"LEFT",
"RIGHT"
],
"type": "string"
},
"lineNumber": {
"description": "The line number that was changed",
"type": [
"integer",
"string"
]
},
"packageActions": {
"description": "The package actions that were needed to support changes to the file",
"items": {
"$ref": "#/definitions/packageAction"
},
"type": "array"
},
"properties": {
"additionalProperties": true,
"description": "Vendor-specific properties to help storytelling",
"type": "object"
}
},
"required": [
"lineNumber",
"diffSide"
],
"type": "object"
},
"changeset": {
"properties": {
"changes": {
"items": {
"$ref": "#/definitions/change"
},
"minItems": 1,
"type": "array"
},
"diff": {
"description": "The unified diff format of the changes made to the file",
"type": "string"
},
"path": {
"description": "The path of the file (relative to the directory) that was changed",
"type": "string"
}
},
"required": [
"path",
"diff",
"changes"
],
"type": "object"
},
"detectionTool": {
"additionalProperties": true,
"properties": {
"findings": {
"items": {
"$ref": "#/definitions/detector/finding"
},
"type": "array"
},
"name": {
"description": "Name of the tool that detected the issue",
"type": "string"
},
"rule": {
"$ref": "#/definitions/detector/rule",
"description": "The rule that detected the issue"
}
},
"required": [
"name",
"rule",
"findings"
],
"type": "object"
},
"detector": {
"finding": {
"additionalProperties": true,
"if": {
"properties": {
"fixed": {
"boolean": false
}
},
"required": [
"reason"
]
},
"properties": {
"fixed": {
"description": "Whether the finding was fixed by the codemod",
"type": "boolean"
},
"guid": {
"description": "A unique identifier for the finding",
"type": "string"
},
"reason": {
"description": "Reason the finding was not fixed",
"type": "string"
}
},
"required": [
"guid",
"fixed"
],
"type": "object"
},
"rule": {
"additionalProperties": false,
"properties": {
"description": {
"description": "A description of the rule",
"type": "string"
},
"id": {
"description": "The ID of the rule",
"type": "string"
},
"name": {
"description": "The name of the rule",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
},
"packageAction": {
"properties": {
"action": {
"description": "One of 'add' or 'remove'",
"enum": [
"add",
"remove",
"ADD",
"REMOVE"
],
"type": "string"
},
"package": {
"description": "The package that was added or removed",
"type": "string"
},
"result": {
"description": "One of 'completed', 'failed', or 'skipped'",
"enum": [
"completed",
"failed",
"skipped",
"COMPLETED",
"FAILED",
"SKIPPED"
],
"type": "string"
}
},
"required": [
"action",
"result",
"package"
],
"type": "object"
},
"reference": {
"properties": {
"description": {
"description": "A description of the reference",
"type": "string"
},
"url": {
"description": "The URL of the reference",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"result": {
"properties": {
"changeset": {
"description": "The changes for a given codemod",
"items": {
"$ref": "#/definitions/changeset"
},
"minItems": 0,
"type": "array"
},
"codemod": {
"description": "ID of the transformation that was applied",
"type": "string"
},
"description": {
"description": "A longer description of the changes made",
"type": "string"
},
"detectionTool": {
"$ref": "#/definitions/detectionTool",
"description": "Metadata about the tool that detected the issue"
},
"failedFiles": {
"description": "A set of file paths for files that the tool failed to parse or transform",
"items": {
"type": "string"
},
"type": "array"
},
"properties": {
"additionalProperties": true,
"description": "Vendor-specific properties to help storytelling",
"type": "object"
},
"references": {
"items": {
"$ref": "#/definitions/reference"
},
"type": "array"
},
"summary": {
"description": "A short phrase describing the changes made",
"type": "string"
}
},
"required": [
"codemod",
"summary",
"description",
"changeset"
],
"type": "object"
},
"run": {
"properties": {
"commandLine": {
"description": "The command line used to re-create this run",
"type": "string"
},
"directory": {
"description": "The location on disk of the code directory being scanned",
"type": "string"
},
"elapsed": {
"description": "How long, in miliseconds, the analysis took to execute",
"type": [
"integer",
"string"
]
},
"projectName": {
"description": "Name of the project that was analyzed",
"type": "string"
},
"sarifs": {
"items": {
"$ref": "#/definitions/sarif"
},
"type": "array"
},
"tool": {
"description": "Name of the tool that produced the CodeTF results",
"type": "string"
},
"vendor": {
"description": "Name of the organization that produced the tool",
"type": "string"
},
"version": {
"description": "Version of the tool that produced the CodeTF results",
"type": "string"
}
},
"required": [
"vendor",
"tool",
"version",
"commandLine",
"elapsed",
"directory"
],
"type": "object"
},
"sarif": {
"properties": {
"artifact": {
"description": "The file containing the SARIF or other input",
"type": "string"
},
"sha1": {
"description": "SHA1 hash representing the artifact",
"type": "string"
}
},
"required": [
"artifact",
"sha1"
],
"type": "object"
}
},
"description": "A format for representing the results of code transformations",
"properties": {
"results": {
"description": "The results of the code transformations that were applied during analysis",
"items": {
"$ref": "#/definitions/result"
},
"minItems": 0,
"type": "array"
},
"run": {
"$ref": "#/definitions/run",
"description": "Metadata about the run that produced the results"
}
},
"required": [
"run",
"results"
],
"title": "Code Transformation Format (CodeTF)",
"type": "object"
} | MIT | en |
pixee/codemodder-specs | 62434baed0554451ac170115795c82dc6df95110 | 2024-05-28T13:57:40 | codetf.schema.json | 14 | 2024-05-27T08:57:42.919452Z | {
"$id": "https://pixee.ai/codetf.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"ai": {
"properties": {
"model": {
"description": "Name of the model used to generate this fix",
"type": "string"
},
"provider": {
"description": "Name of the AI provider used to generate this fix",
"type": "string"
},
"tokens": {
"description": "Total number of tokens used to generate the fix",
"type": "integer"
}
},
"type": "object"
},
"change": {
"properties": {
"description": {
"description": "A human-readable description of the change",
"type": "string"
},
"diffSide": {
"description": "The side of the diff that the change is on. 'right' indicates that the lineNumber and description correspond to a position in the new or modified code. 'left' indicates these fields correspond to a position in the original code. Descriptions of the change itself should generally use 'right', except in cases where the only change is a deletion. In contrast, 'left' can be used to describe the original problem being fixed.",
"enum": [
"left",
"right",
"LEFT",
"RIGHT"
],
"type": "string"
},
"findings": {
"description": "List of findings that were fixed at this location",
"items": {
"$ref": "#/definitions/detector/fixedFinding"
},
"type": "array"
},
"lineNumber": {
"description": "The line number that was changed",
"type": [
"integer",
"string"
]
},
"packageActions": {
"description": "The package actions that were needed to support changes to the file",
"items": {
"$ref": "#/definitions/packageAction"
},
"type": "array"
},
"properties": {
"additionalProperties": true,
"description": "Vendor-specific properties to help storytelling",
"type": "object"
}
},
"required": [
"lineNumber",
"diffSide"
],
"type": "object"
},
"changeset": {
"properties": {
"ai": {
"$ref": "#/definitions/ai",
"description": "Metadata about AI tool used to generate the fix"
},
"changes": {
"items": {
"$ref": "#/definitions/change"
},
"minItems": 1,
"type": "array"
},
"diff": {
"description": "The unified diff format of the changes made to the file",
"type": "string"
},
"path": {
"description": "The path of the file (relative to the directory) that was changed",
"type": "string"
}
},
"required": [
"path",
"diff",
"changes"
],
"type": "object"
},
"detectionTool": {
"additionalProperties": true,
"properties": {
"name": {
"description": "Name of the tool that detected the issue",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"detector": {
"fixedFinding": {
"additionalProperties": true,
"properties": {
"id": {
"description": "A unique identifier for the finding (e.g. 'guid' from SARIF)",
"type": "string"
},
"rule": {
"$ref": "#/definitions/detector/rule",
"description": "The rule that detected the issue"
}
},
"required": [
"id",
"rule"
],
"type": "object"
},
"rule": {
"additionalProperties": false,
"properties": {
"id": {
"description": "The ID of the rule",
"type": "string"
},
"name": {
"description": "The name of the rule. Potentially the same as the ID, but more human-readable",
"type": "string"
},
"url": {
"description": "Link to the rule documentation",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"unfixedFinding": {
"additionalProperties": true,
"properties": {
"id": {
"description": "A unique identifier for the finding (e.g. 'guid' from SARIF)",
"type": "string"
},
"lineNumber": {
"description": "The line number that was not fixed",
"type": "integer"
},
"path": {
"description": "The path of the file (relative to the directory) that was not fixed",
"type": "string"
},
"reason": {
"description": "A human-readable description of the reason the file was not fixed",
"type": "string"
},
"rule": {
"$ref": "#/definitions/detector/rule",
"description": "The rule that detected the issue"
}
},
"required": [
"id",
"rule",
"path",
"reason"
],
"type": "object"
}
},
"packageAction": {
"properties": {
"action": {
"description": "One of 'add' or 'remove'",
"enum": [
"add",
"remove",
"ADD",
"REMOVE"
],
"type": "string"
},
"package": {
"description": "The package that was added or removed",
"type": "string"
},
"result": {
"description": "One of 'completed', 'failed', or 'skipped'",
"enum": [
"completed",
"failed",
"skipped",
"COMPLETED",
"FAILED",
"SKIPPED"
],
"type": "string"
}
},
"required": [
"action",
"result",
"package"
],
"type": "object"
},
"reference": {
"properties": {
"description": {
"description": "A description of the reference",
"type": "string"
},
"url": {
"description": "The URL of the reference",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"result": {
"properties": {
"changeset": {
"description": "The changes for a given codemod",
"items": {
"$ref": "#/definitions/changeset"
},
"minItems": 0,
"type": "array"
},
"codemod": {
"description": "ID of the transformation that was applied",
"type": "string"
},
"description": {
"description": "A longer description of the changes made",
"type": "string"
},
"detectionTool": {
"$ref": "#/definitions/detectionTool",
"description": "Metadata about the tool that detected the issue"
},
"failedFiles": {
"description": "A set of file paths for files that the tool failed to parse or transform",
"items": {
"type": "string"
},
"type": "array"
},
"failure": {
"description": "If present indicates that the codemod failed to run",
"properties": {
"exception": {
"description": "More detailed information about the exception that caused the failure",
"type": "string"
},
"reason": {
"description": "A short description of why the codemod failed",
"type": "string"
}
},
"required": [
"reason"
],
"type": "object"
},
"properties": {
"additionalProperties": true,
"description": "Vendor-specific properties to help storytelling",
"type": "object"
},
"references": {
"items": {
"$ref": "#/definitions/reference"
},
"type": "array"
},
"summary": {
"description": "A short phrase describing the changes made",
"type": "string"
},
"unfixed": {
"description": "A set of file paths for files that the tool failed to fix",
"items": {
"$ref": "#/definitions/unfixedFinding"
},
"type": "array"
}
},
"required": [
"codemod",
"summary",
"description",
"changeset"
],
"type": "object"
},
"run": {
"properties": {
"commandLine": {
"description": "The command line used to re-create this run",
"type": "string"
},
"directory": {
"description": "The location on disk of the code directory being scanned",
"type": "string"
},
"elapsed": {
"description": "How long, in miliseconds, the analysis took to execute",
"type": [
"integer",
"string"
]
},
"projectName": {
"description": "Name of the project that was analyzed",
"type": "string"
},
"sarifs": {
"items": {
"$ref": "#/definitions/sarif"
},
"type": "array"
},
"tool": {
"description": "Name of the tool that produced the CodeTF results",
"type": "string"
},
"vendor": {
"description": "Name of the organization that produced the tool",
"type": "string"
},
"version": {
"description": "Version of the tool that produced the CodeTF results",
"type": "string"
}
},
"required": [
"vendor",
"tool",
"version",
"commandLine",
"elapsed",
"directory"
],
"type": "object"
},
"sarif": {
"properties": {
"artifact": {
"description": "The file containing the SARIF or other input",
"type": "string"
},
"sha1": {
"description": "SHA1 hash representing the artifact",
"type": "string"
}
},
"required": [
"artifact",
"sha1"
],
"type": "object"
}
},
"description": "A format for representing the results of code transformations",
"properties": {
"results": {
"description": "The results of the code transformations that were applied during analysis",
"items": {
"$ref": "#/definitions/result"
},
"minItems": 0,
"type": "array"
},
"run": {
"$ref": "#/definitions/run",
"description": "Metadata about the run that produced the results"
}
},
"required": [
"run",
"results"
],
"title": "Code Transformation Format (CodeTF)",
"type": "object"
} | MIT | en |
pixee/codemodder-specs | 2003be5b2326d6882e06929c57d73280e2d311df | 2024-03-12T15:25:58 | codetf.schema.json | 14 | 2024-05-27T08:57:42.919452Z | {
"$id": "https://pixee.ai/codetf.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"change": {
"properties": {
"description": {
"description": "A human-readable description of the change",
"type": "string"
},
"diffSide": {
"description": "The side of the diff that the change is on. 'right' indicates that the lineNumber and description correspond to a position in the new or modified code. 'left' indicates these fields correspond to a position in the original code. Descriptions of the change itself should generally use 'right', except in cases where the only change is a deletion. In contrast, 'left' can be used to describe the original problem being fixed.",
"enum": [
"left",
"right",
"LEFT",
"RIGHT"
],
"type": "string"
},
"lineNumber": {
"description": "The line number that was changed",
"type": [
"integer",
"string"
]
},
"packageActions": {
"description": "The package actions that were needed to support changes to the file",
"items": {
"$ref": "#/definitions/packageAction"
},
"type": "array"
},
"properties": {
"additionalProperties": true,
"description": "Vendor-specific properties to help storytelling",
"type": "object"
}
},
"required": [
"lineNumber",
"diffSide"
],
"type": "object"
},
"changeset": {
"properties": {
"changes": {
"items": {
"$ref": "#/definitions/change"
},
"minItems": 1,
"type": "array"
},
"diff": {
"description": "The unified diff format of the changes made to the file",
"type": "string"
},
"path": {
"description": "The path of the file (relative to the directory) that was changed",
"type": "string"
}
},
"required": [
"path",
"diff",
"changes"
],
"type": "object"
},
"detectionTool": {
"additionalProperties": true,
"properties": {
"findings": {
"items": {
"$ref": "#/definitions/detector/finding"
},
"maxItems": 20,
"type": "array"
},
"name": {
"description": "Name of the tool that detected the issue",
"type": "string"
},
"rule": {
"$ref": "#/definitions/detector/rule",
"description": "The rule that detected the issue"
}
},
"required": [
"name",
"rule",
"findings"
],
"type": "object"
},
"detector": {
"finding": {
"additionalProperties": true,
"if": {
"properties": {
"fixed": {
"boolean": false
}
},
"required": [
"reason"
]
},
"properties": {
"fixed": {
"description": "Whether the finding was fixed by the codemod",
"type": "boolean"
},
"id": {
"description": "A unique identifier for the finding (e.g. 'guid' from SARIF)",
"type": "string"
},
"reason": {
"description": "Reason the finding was not fixed",
"type": "string"
}
},
"required": [
"id",
"fixed"
],
"type": "object"
},
"rule": {
"additionalProperties": false,
"properties": {
"id": {
"description": "The ID of the rule",
"type": "string"
},
"name": {
"description": "The name of the rule. Potentially the same as the ID, but more human-readable",
"type": "string"
},
"url": {
"description": "Link to the rule documentation",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
},
"packageAction": {
"properties": {
"action": {
"description": "One of 'add' or 'remove'",
"enum": [
"add",
"remove",
"ADD",
"REMOVE"
],
"type": "string"
},
"package": {
"description": "The package that was added or removed",
"type": "string"
},
"result": {
"description": "One of 'completed', 'failed', or 'skipped'",
"enum": [
"completed",
"failed",
"skipped",
"COMPLETED",
"FAILED",
"SKIPPED"
],
"type": "string"
}
},
"required": [
"action",
"result",
"package"
],
"type": "object"
},
"reference": {
"properties": {
"description": {
"description": "A description of the reference",
"type": "string"
},
"url": {
"description": "The URL of the reference",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"result": {
"properties": {
"changeset": {
"description": "The changes for a given codemod",
"items": {
"$ref": "#/definitions/changeset"
},
"minItems": 0,
"type": "array"
},
"codemod": {
"description": "ID of the transformation that was applied",
"type": "string"
},
"description": {
"description": "A longer description of the changes made",
"type": "string"
},
"detectionTool": {
"$ref": "#/definitions/detectionTool",
"description": "Metadata about the tool that detected the issue"
},
"failedFiles": {
"description": "A set of file paths for files that the tool failed to parse or transform",
"items": {
"type": "string"
},
"type": "array"
},
"properties": {
"additionalProperties": true,
"description": "Vendor-specific properties to help storytelling",
"type": "object"
},
"references": {
"items": {
"$ref": "#/definitions/reference"
},
"type": "array"
},
"summary": {
"description": "A short phrase describing the changes made",
"type": "string"
}
},
"required": [
"codemod",
"summary",
"description",
"changeset"
],
"type": "object"
},
"run": {
"properties": {
"commandLine": {
"description": "The command line used to re-create this run",
"type": "string"
},
"directory": {
"description": "The location on disk of the code directory being scanned",
"type": "string"
},
"elapsed": {
"description": "How long, in miliseconds, the analysis took to execute",
"type": [
"integer",
"string"
]
},
"projectName": {
"description": "Name of the project that was analyzed",
"type": "string"
},
"sarifs": {
"items": {
"$ref": "#/definitions/sarif"
},
"type": "array"
},
"tool": {
"description": "Name of the tool that produced the CodeTF results",
"type": "string"
},
"vendor": {
"description": "Name of the organization that produced the tool",
"type": "string"
},
"version": {
"description": "Version of the tool that produced the CodeTF results",
"type": "string"
}
},
"required": [
"vendor",
"tool",
"version",
"commandLine",
"elapsed",
"directory"
],
"type": "object"
},
"sarif": {
"properties": {
"artifact": {
"description": "The file containing the SARIF or other input",
"type": "string"
},
"sha1": {
"description": "SHA1 hash representing the artifact",
"type": "string"
}
},
"required": [
"artifact",
"sha1"
],
"type": "object"
}
},
"description": "A format for representing the results of code transformations",
"properties": {
"results": {
"description": "The results of the code transformations that were applied during analysis",
"items": {
"$ref": "#/definitions/result"
},
"minItems": 0,
"type": "array"
},
"run": {
"$ref": "#/definitions/run",
"description": "Metadata about the run that produced the results"
}
},
"required": [
"run",
"results"
],
"title": "Code Transformation Format (CodeTF)",
"type": "object"
} | MIT | en |
jelovirt/pdf-generator | c362dbc18f08e60e442d0fab049659e4ed065272 | 2023-02-16T18:04:16 | src/main/resources/schema.json | 12 | 2024-05-28T04:36:36.069549Z | {
"$defs": {
"block-style-type": {
"properties": {
"background-color": {
"$ref": "#/$defs/colour-type"
},
"border-after-color": {
"$ref": "#/$defs/colour-type"
},
"border-after-style": {
"$ref": "#/$defs/border-style-type"
},
"border-after-width": {
"$ref": "#/$defs/length-type"
},
"border-before-color": {
"$ref": "#/$defs/colour-type"
},
"border-before-style": {
"$ref": "#/$defs/border-style-type"
},
"border-before-width": {
"$ref": "#/$defs/length-type"
},
"border-end-color": {
"$ref": "#/$defs/colour-type"
},
"border-end-style": {
"$ref": "#/$defs/border-style-type"
},
"border-end-width": {
"$ref": "#/$defs/length-type"
},
"border-start-color": {
"$ref": "#/$defs/colour-type"
},
"border-start-style": {
"$ref": "#/$defs/border-style-type"
},
"border-start-width": {
"$ref": "#/$defs/length-type"
},
"color": {
"$ref": "#/$defs/colour-type"
},
"end-indent": {
"$ref": "#/$defs/length-type"
},
"font-family": {
"type": "string"
},
"font-size": {
"$ref": "#/$defs/length-type"
},
"font-style": {
"type": "string"
},
"font-weight": {
"$ref": "#/$defs/font-weight-type"
},
"line-height": {
"$ref": "#/$defs/length-type"
},
"padding-after": {
"$ref": "#/$defs/length-type"
},
"padding-before": {
"$ref": "#/$defs/length-type"
},
"padding-end": {
"$ref": "#/$defs/length-type"
},
"padding-start": {
"$ref": "#/$defs/length-type"
},
"space-after": {
"$ref": "#/$defs/length-type"
},
"space-before": {
"$ref": "#/$defs/length-type"
},
"start-indent": {
"$ref": "#/$defs/length-type"
},
"text-align": {
"type": "string"
},
"text-decoration": {
"type": "string"
}
}
},
"body-type": {
"$ref": "#/$defs/block-style-type",
"properties": {}
},
"border-style-type": {
"enum": [
"none",
"hidden",
"dotted",
"dashed",
"solid",
"double",
"groove",
"ridge",
"inset",
"outset",
"inherit"
],
"type": "string"
},
"caption-type": {
"properties": {
"caption-number": {
"description": "Number captions.",
"enum": [
"chapter",
"document",
"none"
],
"type": "string"
},
"caption-position": {
"description": "Caption position.",
"enum": [
"after",
"before"
],
"type": "string"
}
}
},
"codeblock-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"caption-number": {
"description": "Number figures with chapter prefix or use whole document numbering.",
"enum": [
"chapter",
"document"
],
"type": "string"
},
"caption-position": {
"description": "Place figure caption before or after figure.",
"enum": [
"before",
"after"
],
"type": "string"
},
"line-numbering": {
"description": "Show line numbers.",
"type": "boolean"
},
"show-whitespace": {
"description": "Show whitespace characters.",
"type": "boolean"
}
}
},
"colour-type": {
"pattern": "^(#[a-eA-E0-9]{6}|#[a-eA-E0-9]{3}|rgb\\(\\d+,\\d+,\\d+\\)|rgb\\(\\d+%,\\d+%,\\d+%\\)|transparent|aqua|black|blue|cyan|fuchsia|gray|green|lime|maroon|navy|olive|orange|pink|purple|red|silver|teal|white|yellow|inherit)$",
"type": "string"
},
"content-array-type": {
"allOf": [
{
"properties": {
"kind": {
"description": "Type of content block.",
"enum": [
"field"
],
"type": "string"
},
"value": {
"description": "Field name.",
"enum": [
"title",
"chapter",
"folio",
"folio-with-total"
],
"type": "string"
}
}
},
{
"properties": {
"kind": {
"description": "Type of content block.",
"enum": [
"text"
],
"type": "string"
},
"value": {
"description": "Text content of block.",
"type": "string"
}
}
}
],
"description": "Header or footer contents. This is the parsed form of contents template.",
"examples": [
[
{
"kind": "field",
"value": "title"
},
{
"kind": "text",
"value": " \u2014 "
},
{
"kind": "field",
"value": "chapter"
}
]
],
"minItems": 0,
"type": "array"
},
"content-template-type": {
"description": "Header or footer contents template.",
"examples": [
"{title} \u2014 {chapter}"
],
"type": "string"
},
"content-type": {
"properties": {
"content": {
"anyOf": [
{
"$ref": "#/$defs/content-template-type"
},
{
"$ref": "#/$defs/content-array-type"
}
]
}
}
},
"dl-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"dl-type": {
"description": "Definition list output style.",
"enum": [
"html",
"table",
"list"
],
"type": "string"
}
}
},
"font-weight-type": {
"enum": [
"normal",
"bold",
"bolder",
"lighter",
"100",
"200",
"300",
"400",
"500",
"600",
"700",
"800",
"900",
"inherit"
],
"type": "string"
},
"header-type": {
"description": "Page header and footer configuration.",
"properties": {
"even": {
"$ref": "#/$defs/odd-type",
"description": "Header or footer on recto pages."
},
"odd": {
"$ref": "#/$defs/odd-type",
"description": "Header or footer on verso pages."
}
}
},
"inline-style-type": {
"properties": {
"background-color": {
"$ref": "#/$defs/colour-type"
},
"color": {
"$ref": "#/$defs/colour-type"
},
"font-family": {
"type": "string"
},
"font-size": {
"$ref": "#/$defs/length-type"
},
"font-style": {
"enum": [
"normal",
"italic",
"oblique",
"backslant",
"inherit"
],
"type": "string"
},
"font-weight": {
"$ref": "#/$defs/font-weight-type"
},
"line-height": {
"$ref": "#/$defs/length-type"
},
"text-decoration": {
"type": "string"
}
}
},
"label-type": {
"properties": {
"label": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/content-type"
}
]
}
}
},
"length-type": {
"pattern": "^-?\\d+(\\.\\d+)?(cm|mm|in|pt|pc|px|em)?$",
"type": "string"
},
"link-type": {
"$ref": "#/$defs/inline-style-type",
"properties": {
"link-page-number": {
"description": "Generate page number to internal links.",
"type": "boolean"
}
}
},
"note-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/label-type"
}
]
},
"odd-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/content-type"
}
]
},
"ol-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"ol-1": {
"type": "string"
},
"ol-2": {
"type": "string"
},
"ol-3": {
"type": "string"
},
"ol-4": {
"type": "string"
},
"ol-after-1": {
"type": "string"
},
"ol-after-2": {
"type": "string"
},
"ol-after-3": {
"type": "string"
},
"ol-after-4": {
"type": "string"
}
}
},
"page-size-type": {
"oneOf": [
{
"properties": {
"orientation": {
"default": "portrait",
"description": "Page orientation.",
"enum": [
"portrait",
"letter"
],
"type": "string"
},
"size": {
"default": "Letter",
"description": "Page size.",
"enum": [
"A3",
"A4",
"A5",
"Executive",
"JIS B5",
"Tabloid",
"Legal",
"Letter",
"PA4"
],
"type": "string"
}
},
"required": [
"size"
]
},
{
"properties": {
"height": {
"$ref": "#/$defs/length-type",
"default": "11in",
"description": "Page height."
},
"width": {
"$ref": "#/$defs/length-type",
"default": "8.5in",
"description": "Page width."
}
},
"required": [
"height",
"width"
]
}
]
},
"page-type": {
"allOf": [
{
"$ref": "#/$defs/page-size-type"
},
{
"properties": {
"blank-pages": {
"default": false,
"description": "Mark blank pages with ",
"type": "boolean"
},
"body-column-count": {
"default": 1,
"description": "Column count on content pages.",
"type": "integer"
},
"bottom": {
"$ref": "#/$defs/length-type",
"default": "20mm",
"description": "Page bottom margin."
},
"column-gap": {
"$ref": "#/$defs/length-type",
"description": "Column gap on multi column pages."
},
"force-count": {
"default": "auto",
"description": "Force chapter to end on even or odd pages.",
"enum": [
"auto",
"even",
"odd"
],
"type": "string"
},
"index-column-count": {
"default": 2,
"description": "Column count on index pages.",
"type": "integer"
},
"inside": {
"$ref": "#/$defs/length-type",
"default": "20mm",
"description": "Page inside margin."
},
"mirror-margins": {
"default": false,
"description": "Duplex pages with recto and verso pages.",
"type": "boolean"
},
"outside": {
"$ref": "#/$defs/length-type",
"default": "20mm",
"description": "Page outside margin."
},
"top": {
"$ref": "#/$defs/length-type",
"default": "20mm",
"description": "Page top margin."
}
}
}
],
"description": "Page configuration.",
"examples": [
{
"bottom": "20mm",
"height": "297mm",
"inside": "30mm",
"outside": "20mm",
"top": "20mm",
"width": "210mm"
}
]
},
"section-type": {
"$ref": "#/$defs/body-type",
"properties": {
"title": {
"$ref": "#/$defs/body-type"
}
}
},
"style-type": {
"allOf": [
{
"properties": {
"apiname": {
"$ref": "#/$defs/inline-style-type"
},
"b": {
"$ref": "#/$defs/inline-style-type"
},
"body": {
"$ref": "#/$defs/body-type"
},
"cmdname": {
"$ref": "#/$defs/inline-style-type"
},
"codeblock": {
"$ref": "#/$defs/codeblock-type"
},
"codeph": {
"$ref": "#/$defs/inline-style-type"
},
"cover": {
"$ref": "#/$defs/block-style-type",
"properties": {
"image-metadata": {
"default": null,
"description": "Name of metadata element to use as cover image.",
"type": "string"
},
"image-topic": {
"default": null,
"description": "Outputclass for cover topic.",
"type": "string"
},
"title": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/content-type"
}
]
}
}
},
"delim": {
"$ref": "#/$defs/inline-style-type"
},
"dl": {
"$ref": "#/$defs/dl-type"
},
"example": {
"$ref": "#/$defs/section-type"
},
"fig": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/caption-type"
}
]
},
"filepath": {
"$ref": "#/$defs/inline-style-type"
},
"fragment": {
"$ref": "#/$defs/inline-style-type"
},
"fragref": {
"$ref": "#/$defs/inline-style-type"
},
"groupchoice": {
"$ref": "#/$defs/inline-style-type"
},
"groupcomp": {
"$ref": "#/$defs/inline-style-type"
},
"groupseq": {
"$ref": "#/$defs/inline-style-type"
},
"h1": {
"$ref": "#/$defs/topic-type"
},
"h2": {
"$ref": "#/$defs/topic-type"
},
"h3": {
"$ref": "#/$defs/topic-type"
},
"h4": {
"$ref": "#/$defs/topic-type"
},
"i": {
"$ref": "#/$defs/inline-style-type"
},
"keyword": {
"$ref": "#/$defs/inline-style-type"
},
"kwd": {
"$ref": "#/$defs/inline-style-type"
},
"line-through": {
"$ref": "#/$defs/inline-style-type"
},
"link": {
"$ref": "#/$defs/link-type",
"properties": {
"external": {
"$ref": "#/$defs/content-type"
}
}
},
"markupname": {
"$ref": "#/$defs/inline-style-type"
},
"menucascade": {
"$ref": "#/$defs/inline-style-type"
},
"note": {
"$ref": "#/$defs/note-type",
"properties": {
"attention": {
"$ref": "#/$defs/note-type"
},
"caution": {
"$ref": "#/$defs/note-type"
},
"danger": {
"$ref": "#/$defs/note-type"
},
"fastpath": {
"$ref": "#/$defs/note-type"
},
"important": {
"$ref": "#/$defs/note-type"
},
"note": {
"$ref": "#/$defs/note-type"
},
"notice": {
"$ref": "#/$defs/note-type"
},
"other": {
"$ref": "#/$defs/note-type"
},
"remember": {
"$ref": "#/$defs/note-type"
},
"restriction": {
"$ref": "#/$defs/note-type"
},
"tip": {
"$ref": "#/$defs/note-type"
},
"trouble": {
"$ref": "#/$defs/note-type"
},
"warning": {
"$ref": "#/$defs/note-type"
}
}
},
"numcharref": {
"$ref": "#/$defs/inline-style-type"
},
"ol": {
"$ref": "#/$defs/ol-type"
},
"oper": {
"$ref": "#/$defs/inline-style-type"
},
"option": {
"$ref": "#/$defs/inline-style-type"
},
"overline": {
"$ref": "#/$defs/inline-style-type"
},
"parameterentity": {
"$ref": "#/$defs/inline-style-type"
},
"parmname": {
"$ref": "#/$defs/inline-style-type"
},
"pre": {
"$ref": "#/$defs/body-type"
},
"repsep": {
"$ref": "#/$defs/inline-style-type"
},
"screen": {
"$ref": "#/$defs/inline-style-type"
},
"section": {
"$ref": "#/$defs/section-type"
},
"sep": {
"$ref": "#/$defs/inline-style-type"
},
"shortcut": {
"$ref": "#/$defs/inline-style-type"
},
"shortdesc": {
"$ref": "#/$defs/block-style-type"
},
"sub": {
"$ref": "#/$defs/inline-style-type"
},
"sup": {
"$ref": "#/$defs/inline-style-type"
},
"synblk": {
"$ref": "#/$defs/inline-style-type"
},
"synnote": {
"$ref": "#/$defs/inline-style-type"
},
"synnoteref": {
"$ref": "#/$defs/inline-style-type"
},
"synph": {
"$ref": "#/$defs/inline-style-type"
},
"syntaxdiagram": {
"$ref": "#/$defs/inline-style-type"
},
"systemoutput": {
"$ref": "#/$defs/inline-style-type"
},
"table": {
"$ref": "#/$defs/table-type",
"properties": {
"caption": {
"$ref": "#/$defs/block-style-type"
},
"header": {
"$ref": "#/$defs/block-style-type"
}
}
},
"term": {
"$ref": "#/$defs/inline-style-type"
},
"textentity": {
"$ref": "#/$defs/inline-style-type"
},
"tm": {
"$ref": "#/$defs/tm-type"
},
"toc-1": {
"$ref": "#/$defs/toc-1-type"
},
"toc-2": {
"$ref": "#/$defs/body-type"
},
"toc-3": {
"$ref": "#/$defs/body-type"
},
"toc-4": {
"$ref": "#/$defs/body-type"
},
"tt": {
"$ref": "#/$defs/inline-style-type"
},
"u": {
"$ref": "#/$defs/inline-style-type"
},
"uicontrol": {
"$ref": "#/$defs/inline-style-type"
},
"ul": {
"$ref": "#/$defs/ul-type"
},
"userinput": {
"$ref": "#/$defs/inline-style-type"
},
"var": {
"$ref": "#/$defs/inline-style-type"
},
"varname": {
"$ref": "#/$defs/inline-style-type"
},
"wintitle": {
"$ref": "#/$defs/inline-style-type"
},
"xmlatt": {
"$ref": "#/$defs/inline-style-type"
},
"xmlelement": {
"$ref": "#/$defs/inline-style-type"
},
"xmlnsname": {
"$ref": "#/$defs/inline-style-type"
},
"xmlpi": {
"$ref": "#/$defs/inline-style-type"
}
}
}
]
},
"table-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/caption-type"
}
],
"properties": {
"table-continued": {
"default": false,
"description": "Generate 'Table continued' on page break within table.",
"type": "boolean"
}
}
},
"tm-type": {
"$ref": "#/$defs/inline-style-type",
"properties": {
"symbol-scope": {
"type": "string"
}
}
},
"toc-1-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"prefix": {
"type": "boolean"
}
}
},
"topic-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"title-numbering": {
"description": "Generate title numbering.",
"type": "boolean"
}
}
},
"ul-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"ul-1": {
"type": "string"
},
"ul-2": {
"type": "string"
},
"ul-3": {
"type": "string"
},
"ul-4": {
"type": "string"
}
}
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"default": "Theme template.",
"properties": {
"$schema": {
"type": "string"
},
"bookmark-style": {
"default": "COLLAPSED",
"description": "Expand state of PDF bookmarks.",
"enum": [
"COLLAPSED",
"EXPANDED"
],
"type": "string"
},
"chapter-layout": {
"default": "MINITOC",
"description": "Generate TOC for section.",
"enum": [
"MINITOC",
"BASIC"
],
"type": "string"
},
"extends": {
"description": "Extend another theme. Value is a URI to the theme to be extended.",
"type": "string"
},
"footer": {
"$ref": "#/$defs/header-type",
"description": "Page footer configuration."
},
"header": {
"$ref": "#/$defs/header-type",
"description": "Page header configuration."
},
"include-related-links": {
"default": "nofamily",
"description": "Specifies which link types are used to generate related links.",
"enum": [
"none",
"all",
"nofamily"
],
"type": "string"
},
"page": {
"$ref": "#/$defs/page-type",
"description": "Page configuration."
},
"page-number": {
"default": "page",
"description": "Generate page numbers with chapter number.",
"enum": [
"page",
"chapter-page"
],
"type": "string"
},
"style": {
"$ref": "#/$defs/style-type",
"description": "Style configuration."
},
"task-label": {
"default": false,
"description": "Generate labels for task sections.",
"type": "boolean"
},
"toc-maximum-level": {
"default": 4,
"description": "Maximum TOC depth.",
"type": "integer"
}
}
} | Apache-2.0 | en |
jelovirt/pdf-generator | 64d69a8b836212dc3036828537c6f48ff5eff3c4 | 2023-02-16T16:17:00 | src/main/resources/schema.json | 12 | 2024-05-28T04:36:36.069549Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"default": "Theme template.",
"definitions": {
"block-style-type": {
"properties": {
"background-color": {
"$ref": "#/definitions/colour-type"
},
"border-after-color": {
"$ref": "#/definitions/colour-type"
},
"border-after-style": {
"$ref": "#/definitions/border-style-type"
},
"border-after-width": {
"$ref": "#/definitions/length-type"
},
"border-before-color": {
"$ref": "#/definitions/colour-type"
},
"border-before-style": {
"$ref": "#/definitions/border-style-type"
},
"border-before-width": {
"$ref": "#/definitions/length-type"
},
"border-end-color": {
"$ref": "#/definitions/colour-type"
},
"border-end-style": {
"$ref": "#/definitions/border-style-type"
},
"border-end-width": {
"$ref": "#/definitions/length-type"
},
"border-start-color": {
"$ref": "#/definitions/colour-type"
},
"border-start-style": {
"$ref": "#/definitions/border-style-type"
},
"border-start-width": {
"$ref": "#/definitions/length-type"
},
"color": {
"$ref": "#/definitions/colour-type"
},
"end-indent": {
"$ref": "#/definitions/length-type"
},
"font-family": {
"type": "string"
},
"font-size": {
"$ref": "#/definitions/length-type"
},
"font-style": {
"type": "string"
},
"font-weight": {
"$ref": "#/definitions/font-weight-type"
},
"line-height": {
"$ref": "#/definitions/length-type"
},
"padding-after": {
"$ref": "#/definitions/length-type"
},
"padding-before": {
"$ref": "#/definitions/length-type"
},
"padding-end": {
"$ref": "#/definitions/length-type"
},
"padding-start": {
"$ref": "#/definitions/length-type"
},
"space-after": {
"$ref": "#/definitions/length-type"
},
"space-before": {
"$ref": "#/definitions/length-type"
},
"start-indent": {
"$ref": "#/definitions/length-type"
},
"text-align": {
"type": "string"
},
"text-decoration": {
"type": "string"
}
},
"type": "object"
},
"body-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {},
"type": "object"
},
"border-style-type": {
"enum": [
"none",
"hidden",
"dotted",
"dashed",
"solid",
"double",
"groove",
"ridge",
"inset",
"outset",
"inherit"
],
"type": "string"
},
"caption-type": {
"properties": {
"caption-number": {
"description": "Number captions.",
"enum": [
"chapter",
"document",
"none"
],
"type": "string"
},
"caption-position": {
"description": "Caption position.",
"enum": [
"after",
"before"
],
"type": "string"
}
}
},
"codeblock-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"caption-number": {
"description": "Number figures with chapter prefix or use whole document numbering.",
"enum": [
"chapter",
"document"
],
"type": "string"
},
"caption-position": {
"description": "Place figure caption before or after figure.",
"enum": [
"before",
"after"
],
"type": "string"
},
"line-numbering": {
"description": "Show line numbers.",
"type": "boolean"
},
"show-whitespace": {
"description": "Show whitespace characters.",
"type": "boolean"
}
},
"type": "object"
},
"colour-type": {
"pattern": "^(#[a-eA-E0-9]{6}|#[a-eA-E0-9]{3}|rgb\\(\\d+,\\d+,\\d+\\)|rgb\\(\\d+%,\\d+%,\\d+%\\)|transparent|aqua|black|blue|cyan|fuchsia|gray|green|lime|maroon|navy|olive|orange|pink|purple|red|silver|teal|white|yellow|inherit)$",
"type": "string"
},
"content-array-type": {
"allOf": [
{
"properties": {
"kind": {
"description": "Type of content block.",
"enum": [
"field"
],
"type": "string"
},
"value": {
"description": "Field name.",
"enum": [
"title",
"chapter",
"folio",
"folio-with-total"
],
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"kind": {
"description": "Type of content block.",
"enum": [
"text"
],
"type": "string"
},
"value": {
"description": "Text content of block.",
"type": "string"
}
},
"type": "object"
}
],
"description": "Header or footer contents. This is the parsed form of contents template.",
"examples": [
[
{
"kind": "field",
"value": "title"
},
{
"kind": "text",
"value": " \u2014 "
},
{
"kind": "field",
"value": "chapter"
}
]
],
"minItems": 0,
"type": "array"
},
"content-template-type": {
"description": "Header or footer contents template.",
"examples": [
"{title} \u2014 {chapter}"
],
"type": "string"
},
"content-type": {
"properties": {
"content": {
"anyOf": [
{
"$ref": "#/definitions/content-template-type"
},
{
"$ref": "#/definitions/content-array-type"
}
]
}
},
"type": "object"
},
"dl-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"dl-type": {
"description": "Definition list output style.",
"enum": [
"html",
"table",
"list"
],
"type": "string"
}
},
"type": "object"
},
"font-weight-type": {
"enum": [
"normal",
"bold",
"bolder",
"lighter",
"100",
"200",
"300",
"400",
"500",
"600",
"700",
"800",
"900",
"inherit"
],
"type": "string"
},
"header-type": {
"description": "Page header and footer configuration.",
"properties": {
"even": {
"allOf": [
{
"$ref": "#/definitions/odd-type"
}
],
"description": "Header or footer on recto pages."
},
"odd": {
"allOf": [
{
"$ref": "#/definitions/odd-type"
}
],
"description": "Header or footer on verso pages."
}
},
"type": "object"
},
"inline-style-type": {
"properties": {
"background-color": {
"$ref": "#/definitions/colour-type"
},
"color": {
"$ref": "#/definitions/colour-type"
},
"font-family": {
"type": "string"
},
"font-size": {
"$ref": "#/definitions/length-type"
},
"font-style": {
"enum": [
"normal",
"italic",
"oblique",
"backslant",
"inherit"
],
"type": "string"
},
"font-weight": {
"$ref": "#/definitions/font-weight-type"
},
"line-height": {
"$ref": "#/definitions/length-type"
},
"text-decoration": {
"type": "string"
}
},
"type": "object"
},
"label-type": {
"properties": {
"label": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/content-type"
}
]
}
}
},
"length-type": {
"pattern": "^-?\\d+(\\.\\d+)?(cm|mm|in|pt|pc|px|em)?$",
"type": "string"
},
"link-type": {
"allOf": [
{
"$ref": "#/definitions/inline-style-type"
}
],
"properties": {
"link-page-number": {
"description": "Generate page number to internal links.",
"type": "boolean"
}
},
"type": "object"
},
"note-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/label-type"
}
],
"type": "object"
},
"odd-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/content-type"
}
]
},
"ol-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"ol-1": {
"type": "string"
},
"ol-2": {
"type": "string"
},
"ol-3": {
"type": "string"
},
"ol-4": {
"type": "string"
},
"ol-after-1": {
"type": "string"
},
"ol-after-2": {
"type": "string"
},
"ol-after-3": {
"type": "string"
},
"ol-after-4": {
"type": "string"
}
},
"type": "object"
},
"page-size-type": {
"oneOf": [
{
"properties": {
"orientation": {
"default": "portrait",
"description": "Page orientation.",
"enum": [
"portrait",
"letter"
],
"type": "string"
},
"size": {
"default": "Letter",
"description": "Page size.",
"enum": [
"A3",
"A4",
"A5",
"Executive",
"JIS B5",
"Tabloid",
"Legal",
"Letter",
"PA4"
],
"type": "string"
}
},
"required": [
"size"
],
"type": "object"
},
{
"properties": {
"height": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "11in",
"description": "Page height."
},
"width": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "8.5in",
"description": "Page width."
}
},
"required": [
"height",
"width"
],
"type": "object"
}
],
"type": "object"
},
"page-type": {
"allOf": [
{
"$ref": "#/definitions/page-size-type"
},
{
"properties": {
"blank-pages": {
"default": false,
"description": "Mark blank pages with ",
"type": "boolean"
},
"body-column-count": {
"default": 1,
"description": "Column count on content pages.",
"type": "integer"
},
"bottom": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "20mm",
"description": "Page bottom margin."
},
"column-gap": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"description": "Column gap on multi column pages."
},
"force-count": {
"default": "auto",
"description": "Force chapter to end on even or odd pages.",
"enum": [
"auto",
"even",
"odd"
],
"type": "string"
},
"index-column-count": {
"default": 2,
"description": "Column count on index pages.",
"type": "integer"
},
"inside": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "20mm",
"description": "Page inside margin."
},
"mirror-margins": {
"default": false,
"description": "Duplex pages with recto and verso pages.",
"type": "boolean"
},
"outside": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "20mm",
"description": "Page outside margin."
},
"top": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "20mm",
"description": "Page top margin."
}
}
}
],
"description": "Page configuration.",
"examples": [
{
"bottom": "20mm",
"height": "297mm",
"inside": "30mm",
"outside": "20mm",
"top": "20mm",
"width": "210mm"
}
],
"type": "object"
},
"section-type": {
"allOf": [
{
"$ref": "#/definitions/body-type"
}
],
"properties": {
"title": {
"$ref": "#/definitions/body-type"
}
},
"type": "object"
},
"style-type": {
"allOf": [
{
"properties": {
"apiname": {
"$ref": "#/definitions/inline-style-type"
},
"b": {
"$ref": "#/definitions/inline-style-type"
},
"body": {
"$ref": "#/definitions/body-type"
},
"cmdname": {
"$ref": "#/definitions/inline-style-type"
},
"codeblock": {
"$ref": "#/definitions/codeblock-type"
},
"codeph": {
"$ref": "#/definitions/inline-style-type"
},
"cover": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"properties": {
"image-metadata": {
"default": null,
"description": "Name of metadata element to use as cover image.",
"type": "string"
},
"image-topic": {
"default": null,
"description": "Outputclass for cover topic.",
"type": "string"
},
"title": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/content-type"
}
]
}
}
}
]
},
"delim": {
"$ref": "#/definitions/inline-style-type"
},
"dl": {
"$ref": "#/definitions/dl-type"
},
"example": {
"$ref": "#/definitions/section-type"
},
"fig": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/caption-type"
}
],
"type": "object"
},
"filepath": {
"$ref": "#/definitions/inline-style-type"
},
"fragment": {
"$ref": "#/definitions/inline-style-type"
},
"fragref": {
"$ref": "#/definitions/inline-style-type"
},
"groupchoice": {
"$ref": "#/definitions/inline-style-type"
},
"groupcomp": {
"$ref": "#/definitions/inline-style-type"
},
"groupseq": {
"$ref": "#/definitions/inline-style-type"
},
"h1": {
"$ref": "#/definitions/topic-type"
},
"h2": {
"$ref": "#/definitions/topic-type"
},
"h3": {
"$ref": "#/definitions/topic-type"
},
"h4": {
"$ref": "#/definitions/topic-type"
},
"i": {
"$ref": "#/definitions/inline-style-type"
},
"keyword": {
"$ref": "#/definitions/inline-style-type"
},
"kwd": {
"$ref": "#/definitions/inline-style-type"
},
"line-through": {
"$ref": "#/definitions/inline-style-type"
},
"link": {
"allOf": [
{
"$ref": "#/definitions/link-type"
}
],
"properties": {
"external": {
"allOf": [
{
"$ref": "#/definitions/content-type"
}
]
}
}
},
"markupname": {
"$ref": "#/definitions/inline-style-type"
},
"menucascade": {
"$ref": "#/definitions/inline-style-type"
},
"note": {
"allOf": [
{
"$ref": "#/definitions/note-type"
},
{
"properties": {
"attention": {
"$ref": "#/definitions/note-type"
},
"caution": {
"$ref": "#/definitions/note-type"
},
"danger": {
"$ref": "#/definitions/note-type"
},
"fastpath": {
"$ref": "#/definitions/note-type"
},
"important": {
"$ref": "#/definitions/note-type"
},
"note": {
"$ref": "#/definitions/note-type"
},
"notice": {
"$ref": "#/definitions/note-type"
},
"other": {
"$ref": "#/definitions/note-type"
},
"remember": {
"$ref": "#/definitions/note-type"
},
"restriction": {
"$ref": "#/definitions/note-type"
},
"tip": {
"$ref": "#/definitions/note-type"
},
"trouble": {
"$ref": "#/definitions/note-type"
},
"warning": {
"$ref": "#/definitions/note-type"
}
},
"type": "object"
}
],
"type": "object"
},
"numcharref": {
"$ref": "#/definitions/inline-style-type"
},
"ol": {
"$ref": "#/definitions/ol-type"
},
"oper": {
"$ref": "#/definitions/inline-style-type"
},
"option": {
"$ref": "#/definitions/inline-style-type"
},
"overline": {
"$ref": "#/definitions/inline-style-type"
},
"parameterentity": {
"$ref": "#/definitions/inline-style-type"
},
"parmname": {
"$ref": "#/definitions/inline-style-type"
},
"pre": {
"$ref": "#/definitions/body-type"
},
"repsep": {
"$ref": "#/definitions/inline-style-type"
},
"screen": {
"$ref": "#/definitions/inline-style-type"
},
"section": {
"$ref": "#/definitions/section-type"
},
"sep": {
"$ref": "#/definitions/inline-style-type"
},
"shortcut": {
"$ref": "#/definitions/inline-style-type"
},
"shortdesc": {},
"sub": {
"$ref": "#/definitions/inline-style-type"
},
"sup": {
"$ref": "#/definitions/inline-style-type"
},
"synblk": {
"$ref": "#/definitions/inline-style-type"
},
"synnote": {
"$ref": "#/definitions/inline-style-type"
},
"synnoteref": {
"$ref": "#/definitions/inline-style-type"
},
"synph": {
"$ref": "#/definitions/inline-style-type"
},
"syntaxdiagram": {
"$ref": "#/definitions/inline-style-type"
},
"systemoutput": {
"$ref": "#/definitions/inline-style-type"
},
"table": {
"allOf": [
{
"$ref": "#/definitions/table-type"
}
],
"properties": {
"caption": {
"$ref": "#/definitions/block-style-type"
},
"header": {
"$ref": "#/definitions/block-style-type"
}
}
},
"term": {
"$ref": "#/definitions/inline-style-type"
},
"textentity": {
"$ref": "#/definitions/inline-style-type"
},
"tm": {
"$ref": "#/definitions/tm-type"
},
"toc-1": {
"$ref": "#/definitions/toc-1-type"
},
"toc-2": {
"$ref": "#/definitions/body-type"
},
"toc-3": {
"$ref": "#/definitions/body-type"
},
"toc-4": {
"$ref": "#/definitions/body-type"
},
"tt": {
"$ref": "#/definitions/inline-style-type"
},
"u": {
"$ref": "#/definitions/inline-style-type"
},
"uicontrol": {
"$ref": "#/definitions/inline-style-type"
},
"ul": {
"$ref": "#/definitions/ul-type"
},
"userinput": {
"$ref": "#/definitions/inline-style-type"
},
"var": {
"$ref": "#/definitions/inline-style-type"
},
"varname": {
"$ref": "#/definitions/inline-style-type"
},
"wintitle": {
"$ref": "#/definitions/inline-style-type"
},
"xmlatt": {
"$ref": "#/definitions/inline-style-type"
},
"xmlelement": {
"$ref": "#/definitions/inline-style-type"
},
"xmlnsname": {
"$ref": "#/definitions/inline-style-type"
},
"xmlpi": {
"$ref": "#/definitions/inline-style-type"
}
}
}
],
"type": "object"
},
"table-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/caption-type"
}
],
"properties": {
"table-continued": {
"default": false,
"description": "Generate 'Table continued' on page break within table.",
"type": "boolean"
}
},
"type": "object"
},
"tm-type": {
"allOf": [
{
"$ref": "#/definitions/inline-style-type"
}
],
"properties": {
"symbol-scope": {
"type": "string"
}
},
"type": "object"
},
"toc-1-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"prefix": {
"type": "boolean"
}
},
"type": "object"
},
"topic-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"title-numbering": {
"description": "Generate title numbering.",
"type": "boolean"
}
},
"type": "object"
},
"ul-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"ul-1": {
"type": "string"
},
"ul-2": {
"type": "string"
},
"ul-3": {
"type": "string"
},
"ul-4": {
"type": "string"
}
},
"type": "object"
}
},
"properties": {
"$schema": {
"type": "string"
},
"bookmark-style": {
"default": "COLLAPSED",
"description": "Expand state of PDF bookmarks.",
"enum": [
"COLLAPSED",
"EXPANDED"
],
"type": "string"
},
"chapter-layout": {
"default": "MINITOC",
"description": "Generate TOC for section.",
"enum": [
"MINITOC",
"BASIC"
],
"type": "string"
},
"extends": {
"description": "Extend another theme. Value is a URI to the theme to be extended.",
"type": "string"
},
"footer": {
"allOf": [
{
"$ref": "#/definitions/header-type"
}
],
"description": "Page footer configuration.",
"type": "object"
},
"header": {
"allOf": [
{
"$ref": "#/definitions/header-type"
}
],
"description": "Page header configuration.",
"type": "object"
},
"include-related-links": {
"default": "nofamily",
"description": "Specifies which link types are used to generate related links.",
"enum": [
"none",
"all",
"nofamily"
],
"type": "string"
},
"page": {
"allOf": [
{
"$ref": "#/definitions/page-type"
}
],
"description": "Page configuration.",
"type": "object"
},
"page-number": {
"default": "page",
"description": "Generate page numbers with chapter number.",
"enum": [
"page",
"chapter-page"
],
"type": "string"
},
"style": {
"allOf": [
{
"$ref": "#/definitions/style-type"
}
],
"description": "Style configuration.",
"type": "object"
},
"task-label": {
"default": false,
"description": "Generate labels for task sections.",
"type": "boolean"
},
"toc-maximum-level": {
"default": 4,
"description": "Maximum TOC depth.",
"type": "integer"
}
},
"type": "object"
} | Apache-2.0 | en |
jelovirt/pdf-generator | 97686910f928ade6d66348ec5e2654f00844096b | 2023-02-16T16:16:20 | src/main/resources/schema.json | 12 | 2024-05-28T04:36:36.069549Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"default": "Theme template.",
"definitions": {
"block-style-type": {
"properties": {
"background-color": {
"$ref": "#/definitions/colour-type"
},
"border-after-color": {
"$ref": "#/definitions/colour-type"
},
"border-after-style": {
"$ref": "#/definitions/border-style-type"
},
"border-after-width": {
"$ref": "#/definitions/length-type"
},
"border-before-color": {
"$ref": "#/definitions/colour-type"
},
"border-before-style": {
"$ref": "#/definitions/border-style-type"
},
"border-before-width": {
"$ref": "#/definitions/length-type"
},
"border-end-color": {
"$ref": "#/definitions/colour-type"
},
"border-end-style": {
"$ref": "#/definitions/border-style-type"
},
"border-end-width": {
"$ref": "#/definitions/length-type"
},
"border-start-color": {
"$ref": "#/definitions/colour-type"
},
"border-start-style": {
"$ref": "#/definitions/border-style-type"
},
"border-start-width": {
"$ref": "#/definitions/length-type"
},
"color": {
"$ref": "#/definitions/colour-type"
},
"end-indent": {
"$ref": "#/definitions/length-type"
},
"font-family": {
"type": "string"
},
"font-size": {
"$ref": "#/definitions/length-type"
},
"font-style": {
"type": "string"
},
"font-weight": {
"$ref": "#/definitions/font-weight-type"
},
"line-height": {
"$ref": "#/definitions/length-type"
},
"padding-after": {
"$ref": "#/definitions/length-type"
},
"padding-before": {
"$ref": "#/definitions/length-type"
},
"padding-end": {
"$ref": "#/definitions/length-type"
},
"padding-start": {
"$ref": "#/definitions/length-type"
},
"space-after": {
"$ref": "#/definitions/length-type"
},
"space-before": {
"$ref": "#/definitions/length-type"
},
"start-indent": {
"$ref": "#/definitions/length-type"
},
"text-align": {
"type": "string"
},
"text-decoration": {
"type": "string"
}
},
"type": "object"
},
"body-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {},
"type": "object"
},
"border-style-type": {
"enum": [
"none",
"hidden",
"dotted",
"dashed",
"solid",
"double",
"groove",
"ridge",
"inset",
"outset",
"inherit"
],
"type": "string"
},
"caption-type": {
"properties": {
"caption-number": {
"description": "Number captions.",
"enum": [
"chapter",
"document",
"none"
],
"type": "string"
},
"caption-position": {
"description": "Caption position.",
"enum": [
"after",
"before"
],
"type": "string"
}
}
},
"codeblock-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"caption-number": {
"description": "Number figures with chapter prefix or use whole document numbering.",
"enum": [
"chapter",
"document"
],
"type": "string"
},
"caption-position": {
"description": "Place figure caption before or after figure.",
"enum": [
"before",
"after"
],
"type": "string"
},
"line-numbering": {
"description": "Show line numbers.",
"type": "boolean"
},
"show-whitespace": {
"description": "Show whitespace characters.",
"type": "boolean"
}
},
"type": "object"
},
"colour-type": {
"pattern": "^(#[a-eA-E0-9]{6}|#[a-eA-E0-9]{3}|rgb\\(\\d+,\\d+,\\d+\\)|rgb\\(\\d+%,\\d+%,\\d+%\\)|transparent|aqua|black|blue|cyan|fuchsia|gray|green|lime|maroon|navy|olive|orange|pink|purple|red|silver|teal|white|yellow|inherit)$",
"type": "string"
},
"content-array-type": {
"allOf": [
{
"properties": {
"kind": {
"description": "Type of content block.",
"enum": [
"field"
],
"type": "string"
},
"value": {
"description": "Field name.",
"enum": [
"title",
"chapter",
"folio",
"folio-with-total"
],
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"kind": {
"description": "Type of content block.",
"enum": [
"text"
],
"type": "string"
},
"value": {
"description": "Text content of block.",
"type": "string"
}
},
"type": "object"
}
],
"description": "Header or footer contents. This is the parsed form of contents template.",
"examples": [
[
{
"kind": "field",
"value": "title"
},
{
"kind": "text",
"value": " \u2014 "
},
{
"kind": "field",
"value": "chapter"
}
]
],
"minItems": 0,
"type": "array"
},
"content-template-type": {
"description": "Header or footer contents template.",
"examples": [
"{title} \u2014 {chapter}"
],
"type": "string"
},
"content-type": {
"properties": {
"content": {
"anyOf": [
{
"$ref": "#/definitions/content-template-type"
},
{
"$ref": "#/definitions/content-array-type"
}
]
}
},
"type": "object"
},
"dl-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"dl-type": {
"description": "Definition list output style.",
"enum": [
"html",
"table",
"list"
],
"type": "string"
}
},
"type": "object"
},
"font-weight-type": {
"enum": [
"normal",
"bold",
"bolder",
"lighter",
"100",
"200",
"300",
"400",
"500",
"600",
"700",
"800",
"900",
"inherit"
],
"type": "string"
},
"header-type": {
"description": "Page header and footer configuration.",
"properties": {
"even": {
"allOf": [
{
"$ref": "#/definitions/odd-type"
}
],
"description": "Header or footer on recto pages."
},
"odd": {
"allOf": [
{
"$ref": "#/definitions/odd-type"
}
],
"description": "Header or footer on verso pages."
}
},
"type": "object"
},
"inline-style-type": {
"properties": {
"background-color": {
"$ref": "#/definitions/colour-type"
},
"color": {
"$ref": "#/definitions/colour-type"
},
"font-family": {
"type": "string"
},
"font-size": {
"$ref": "#/definitions/length-type"
},
"font-style": {
"enum": [
"normal",
"italic",
"oblique",
"backslant",
"inherit"
],
"type": "string"
},
"font-weight": {
"$ref": "#/definitions/font-weight-type"
},
"line-height": {
"$ref": "#/definitions/length-type"
},
"text-decoration": {
"type": "string"
}
},
"type": "object"
},
"label-type": {
"properties": {
"label": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/content-type"
}
]
}
}
},
"length-type": {
"pattern": "^-?\\d+(\\.\\d+)?(cm|mm|in|pt|pc|px|em)?$",
"type": "string"
},
"link-type": {
"allOf": [
{
"$ref": "#/definitions/inline-style-type"
}
],
"properties": {
"link-page-number": {
"description": "Generate page number to internal links.",
"type": "boolean"
}
},
"type": "object"
},
"note-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/label-type"
}
],
"type": "object"
},
"odd-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/content-type"
}
]
},
"ol-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"ol-1": {
"type": "string"
},
"ol-2": {
"type": "string"
},
"ol-3": {
"type": "string"
},
"ol-4": {
"type": "string"
},
"ol-after-1": {
"type": "string"
},
"ol-after-2": {
"type": "string"
},
"ol-after-3": {
"type": "string"
},
"ol-after-4": {
"type": "string"
}
},
"type": "object"
},
"page-size-type": {
"oneOf": [
{
"properties": {
"orientation": {
"default": "portrait",
"description": "Page orientation.",
"enum": [
"portrait",
"letter"
],
"type": "string"
},
"size": {
"default": "Letter",
"description": "Page size.",
"enum": [
"A3",
"A4",
"A5",
"Executive",
"JIS B5",
"Tabloid",
"Legal",
"Letter",
"PA4"
],
"type": "string"
}
},
"required": [
"size"
],
"type": "object"
},
{
"properties": {
"height": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "11in",
"description": "Page height."
},
"width": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "8.5in",
"description": "Page width."
}
},
"required": [
"height",
"width"
],
"type": "object"
}
],
"type": "object"
},
"page-type": {
"allOf": [
{
"$ref": "#/definitions/page-size-type"
},
{
"properties": {
"blank-pages": {
"default": false,
"description": "Mark blank pages with ",
"type": "boolean"
},
"body-column-count": {
"default": 1,
"description": "Column count on content pages.",
"type": "integer"
},
"bottom": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "20mm",
"description": "Page bottom margin."
},
"column-gap": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"description": "Column gap on multi column pages."
},
"force-count": {
"default": "auto",
"description": "Force chapter to end on even or odd pages.",
"enum": [
"auto",
"even",
"odd"
],
"type": "string"
},
"index-column-count": {
"default": 2,
"description": "Column count on index pages.",
"type": "integer"
},
"inside": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "20mm",
"description": "Page inside margin."
},
"mirror-margins": {
"default": false,
"description": "Duplex pages with recto and verso pages.",
"type": "boolean"
},
"outside": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "20mm",
"description": "Page outside margin."
},
"top": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "20mm",
"description": "Page top margin."
}
}
}
],
"description": "Page configuration.",
"examples": [
{
"bottom": "20mm",
"height": "297mm",
"inside": "30mm",
"outside": "20mm",
"top": "20mm",
"width": "210mm"
}
],
"type": "object"
},
"section-type": {
"allOf": [
{
"$ref": "#/definitions/body-type"
}
],
"properties": {
"title": {
"$ref": "#/definitions/body-type"
}
},
"type": "object"
},
"style-type": {
"allOf": [
{
"properties": {
"body": {
"$ref": "#/definitions/body-type"
},
"cmdname": {
"$ref": "#/definitions/inline-style-type"
},
"codeblock": {
"$ref": "#/definitions/codeblock-type"
},
"codeph": {
"$ref": "#/definitions/inline-style-type"
},
"cover": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"properties": {
"image-metadata": {
"default": null,
"description": "Name of metadata element to use as cover image.",
"type": "string"
},
"image-topic": {
"default": null,
"description": "Outputclass for cover topic.",
"type": "string"
},
"title": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/content-type"
}
]
}
}
}
]
},
"dl": {
"$ref": "#/definitions/dl-type"
},
"example": {
"$ref": "#/definitions/section-type"
},
"fig": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/caption-type"
}
],
"type": "object"
},
"filepath": {
"$ref": "#/definitions/inline-style-type"
},
"h1": {
"$ref": "#/definitions/topic-type"
},
"h2": {
"$ref": "#/definitions/topic-type"
},
"h3": {
"$ref": "#/definitions/topic-type"
},
"h4": {
"$ref": "#/definitions/topic-type"
},
"keyword": {
"$ref": "#/definitions/inline-style-type"
},
"link": {
"allOf": [
{
"$ref": "#/definitions/link-type"
}
],
"properties": {
"external": {
"allOf": [
{
"$ref": "#/definitions/content-type"
}
]
}
}
},
"note": {
"allOf": [
{
"$ref": "#/definitions/note-type"
},
{
"properties": {
"attention": {
"$ref": "#/definitions/note-type"
},
"caution": {
"$ref": "#/definitions/note-type"
},
"danger": {
"$ref": "#/definitions/note-type"
},
"fastpath": {
"$ref": "#/definitions/note-type"
},
"important": {
"$ref": "#/definitions/note-type"
},
"note": {
"$ref": "#/definitions/note-type"
},
"notice": {
"$ref": "#/definitions/note-type"
},
"other": {
"$ref": "#/definitions/note-type"
},
"remember": {
"$ref": "#/definitions/note-type"
},
"restriction": {
"$ref": "#/definitions/note-type"
},
"tip": {
"$ref": "#/definitions/note-type"
},
"trouble": {
"$ref": "#/definitions/note-type"
},
"warning": {
"$ref": "#/definitions/note-type"
}
},
"type": "object"
}
],
"type": "object"
},
"ol": {
"$ref": "#/definitions/ol-type"
},
"pre": {
"$ref": "#/definitions/body-type"
},
"section": {
"$ref": "#/definitions/section-type"
},
"shortdesc": {},
"systemoutput": {
"$ref": "#/definitions/inline-style-type"
},
"table": {
"allOf": [
{
"$ref": "#/definitions/table-type"
}
],
"properties": {
"caption": {
"$ref": "#/definitions/block-style-type"
},
"header": {
"$ref": "#/definitions/block-style-type"
}
}
},
"term": {
"$ref": "#/definitions/inline-style-type"
},
"tm": {
"$ref": "#/definitions/tm-type"
},
"toc-1": {
"$ref": "#/definitions/toc-1-type"
},
"toc-2": {
"$ref": "#/definitions/body-type"
},
"toc-3": {
"$ref": "#/definitions/body-type"
},
"toc-4": {
"$ref": "#/definitions/body-type"
},
"ul": {
"$ref": "#/definitions/ul-type"
},
"userinput": {
"$ref": "#/definitions/inline-style-type"
},
"varname": {
"$ref": "#/definitions/inline-style-type"
}
}
}
],
"type": "object"
},
"table-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/caption-type"
}
],
"properties": {
"table-continued": {
"default": false,
"description": "Generate 'Table continued' on page break within table.",
"type": "boolean"
}
},
"type": "object"
},
"tm-type": {
"allOf": [
{
"$ref": "#/definitions/inline-style-type"
}
],
"properties": {
"symbol-scope": {
"type": "string"
}
},
"type": "object"
},
"toc-1-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"prefix": {
"type": "boolean"
}
},
"type": "object"
},
"topic-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"title-numbering": {
"description": "Generate title numbering.",
"type": "boolean"
}
},
"type": "object"
},
"ul-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"ul-1": {
"type": "string"
},
"ul-2": {
"type": "string"
},
"ul-3": {
"type": "string"
},
"ul-4": {
"type": "string"
}
},
"type": "object"
}
},
"properties": {
"$schema": {
"type": "string"
},
"bookmark-style": {
"default": "COLLAPSED",
"description": "Expand state of PDF bookmarks.",
"enum": [
"COLLAPSED",
"EXPANDED"
],
"type": "string"
},
"chapter-layout": {
"default": "MINITOC",
"description": "Generate TOC for section.",
"enum": [
"MINITOC",
"BASIC"
],
"type": "string"
},
"extends": {
"description": "Extend another theme. Value is a URI to the theme to be extended.",
"type": "string"
},
"footer": {
"allOf": [
{
"$ref": "#/definitions/header-type"
}
],
"description": "Page footer configuration."
},
"header": {
"allOf": [
{
"$ref": "#/definitions/header-type"
}
],
"description": "Page header configuration."
},
"include-related-links": {
"default": "nofamily",
"description": "Specifies which link types are used to generate related links.",
"enum": [
"none",
"all",
"nofamily"
],
"type": "string"
},
"page": {
"allOf": [
{
"$ref": "#/definitions/page-type"
}
],
"description": "Page configuration."
},
"page-number": {
"default": "page",
"description": "Generate page numbers with chapter number.",
"enum": [
"page",
"chapter-page"
],
"type": "string"
},
"style": {
"allOf": [
{
"$ref": "#/definitions/style-type"
}
],
"description": "Style configuration."
},
"task-label": {
"default": false,
"description": "Generate labels for task sections.",
"type": "boolean"
},
"toc-maximum-level": {
"default": 4,
"description": "Maximum TOC depth.",
"type": "integer"
}
},
"type": "object"
} | Apache-2.0 | en |
jelovirt/pdf-generator | 36823c80bbcae9b17bbbc55801d06dcf26106729 | 2023-10-23T00:39:13 | src/main/resources/schema.json | 12 | 2024-05-28T04:36:36.069549Z | {
"$defs": {
"block-style-type": {
"properties": {
"background-color": {
"$ref": "#/$defs/colour-type"
},
"border-after-color": {
"$ref": "#/$defs/colour-type"
},
"border-after-style": {
"$ref": "#/$defs/border-style-type"
},
"border-after-width": {
"$ref": "#/$defs/length-type"
},
"border-before-color": {
"$ref": "#/$defs/colour-type"
},
"border-before-style": {
"$ref": "#/$defs/border-style-type"
},
"border-before-width": {
"$ref": "#/$defs/length-type"
},
"border-end-color": {
"$ref": "#/$defs/colour-type"
},
"border-end-style": {
"$ref": "#/$defs/border-style-type"
},
"border-end-width": {
"$ref": "#/$defs/length-type"
},
"border-start-color": {
"$ref": "#/$defs/colour-type"
},
"border-start-style": {
"$ref": "#/$defs/border-style-type"
},
"border-start-width": {
"$ref": "#/$defs/length-type"
},
"color": {
"$ref": "#/$defs/colour-type"
},
"end-indent": {
"$ref": "#/$defs/length-type"
},
"font-family": {
"type": "string"
},
"font-size": {
"$ref": "#/$defs/length-type"
},
"font-style": {
"type": "string"
},
"font-weight": {
"$ref": "#/$defs/font-weight-type"
},
"line-height": {
"$ref": "#/$defs/length-type"
},
"padding-after": {
"$ref": "#/$defs/length-type"
},
"padding-before": {
"$ref": "#/$defs/length-type"
},
"padding-end": {
"$ref": "#/$defs/length-type"
},
"padding-start": {
"$ref": "#/$defs/length-type"
},
"space-after": {
"$ref": "#/$defs/length-type"
},
"space-before": {
"$ref": "#/$defs/length-type"
},
"start-indent": {
"$ref": "#/$defs/length-type"
},
"text-align": {
"type": "string"
},
"text-decoration": {
"type": "string"
}
}
},
"body-type": {
"$ref": "#/$defs/block-style-type",
"properties": {}
},
"border-style-type": {
"enum": [
"none",
"hidden",
"dotted",
"dashed",
"solid",
"double",
"groove",
"ridge",
"inset",
"outset",
"inherit"
],
"type": "string"
},
"caption-type": {
"properties": {
"caption-number": {
"description": "Number captions.",
"enum": [
"chapter",
"document",
"none"
],
"type": "string"
},
"caption-position": {
"description": "Caption position.",
"enum": [
"after",
"before"
],
"type": "string"
}
}
},
"codeblock-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"caption-number": {
"description": "Number figures with chapter prefix or use whole document numbering.",
"enum": [
"chapter",
"document"
],
"type": "string"
},
"caption-position": {
"description": "Place figure caption before or after figure.",
"enum": [
"before",
"after"
],
"type": "string"
},
"line-numbering": {
"description": "Show line numbers.",
"type": "boolean"
},
"show-whitespace": {
"description": "Show whitespace characters.",
"type": "boolean"
}
}
},
"colour-type": {
"pattern": "^(#[a-eA-E0-9]{6}|#[a-eA-E0-9]{3}|rgb\\(\\d+,\\d+,\\d+\\)|rgb\\(\\d+%,\\d+%,\\d+%\\)|transparent|aqua|black|blue|cyan|fuchsia|gray|green|lime|maroon|navy|olive|orange|pink|purple|red|silver|teal|white|yellow|inherit)$",
"type": "string"
},
"content-array-type": {
"allOf": [
{
"properties": {
"kind": {
"description": "Type of content block.",
"enum": [
"field"
],
"type": "string"
},
"value": {
"description": "Field name.",
"enum": [
"title",
"chapter",
"folio",
"folio-with-total"
],
"type": "string"
}
}
},
{
"properties": {
"kind": {
"description": "Type of content block.",
"enum": [
"text"
],
"type": "string"
},
"value": {
"description": "Text content of block.",
"type": "string"
}
}
}
],
"description": "Header or footer contents. This is the parsed form of contents template.",
"examples": [
[
{
"kind": "field",
"value": "title"
},
{
"kind": "text",
"value": " \u2014 "
},
{
"kind": "field",
"value": "chapter"
}
]
],
"minItems": 0,
"type": "array"
},
"content-template-type": {
"description": "Header or footer contents template.",
"examples": [
"{title} \u2014 {chapter}"
],
"type": "string"
},
"content-type": {
"properties": {
"content": {
"anyOf": [
{
"$ref": "#/$defs/content-template-type"
},
{
"$ref": "#/$defs/content-array-type"
}
]
}
}
},
"dl-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"dl-type": {
"description": "Definition list output style.",
"enum": [
"html",
"table",
"list"
],
"type": "string"
}
}
},
"font-weight-type": {
"enum": [
"normal",
"bold",
"bolder",
"lighter",
"100",
"200",
"300",
"400",
"500",
"600",
"700",
"800",
"900",
"inherit"
],
"type": "string"
},
"header-type": {
"description": "Page header and footer configuration.",
"properties": {
"even": {
"$ref": "#/$defs/odd-type",
"description": "Header or footer on recto pages."
},
"odd": {
"$ref": "#/$defs/odd-type",
"description": "Header or footer on verso pages."
}
}
},
"inline-style-type": {
"properties": {
"background-color": {
"$ref": "#/$defs/colour-type"
},
"color": {
"$ref": "#/$defs/colour-type"
},
"font-family": {
"type": "string"
},
"font-size": {
"$ref": "#/$defs/length-type"
},
"font-style": {
"enum": [
"normal",
"italic",
"oblique",
"backslant",
"inherit"
],
"type": "string"
},
"font-weight": {
"$ref": "#/$defs/font-weight-type"
},
"line-height": {
"$ref": "#/$defs/length-type"
},
"text-decoration": {
"type": "string"
}
}
},
"label-type": {
"properties": {
"label": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/content-type"
}
]
}
}
},
"length-type": {
"pattern": "^-?\\d+(\\.\\d+)?(cm|mm|in|pt|pc|px|em)?$",
"type": "string"
},
"link-type": {
"$ref": "#/$defs/inline-style-type",
"properties": {
"link-page-number": {
"description": "Generate page number to internal links.",
"type": "boolean"
}
}
},
"note-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/label-type"
}
]
},
"odd-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/content-type"
}
]
},
"ol-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"ol-1": {
"type": "string"
},
"ol-2": {
"type": "string"
},
"ol-3": {
"type": "string"
},
"ol-4": {
"type": "string"
},
"ol-after-1": {
"type": "string"
},
"ol-after-2": {
"type": "string"
},
"ol-after-3": {
"type": "string"
},
"ol-after-4": {
"type": "string"
}
}
},
"page-size-type": {
"oneOf": [
{
"properties": {
"orientation": {
"default": "portrait",
"description": "Page orientation.",
"enum": [
"portrait",
"letter"
],
"type": "string"
},
"size": {
"default": "Letter",
"description": "Page size.",
"enum": [
"A3",
"A4",
"A5",
"Executive",
"JIS B5",
"Tabloid",
"Legal",
"Letter",
"PA4"
],
"type": "string"
}
},
"required": [
"size"
]
},
{
"properties": {
"height": {
"$ref": "#/$defs/length-type",
"default": "11in",
"description": "Page height."
},
"width": {
"$ref": "#/$defs/length-type",
"default": "8.5in",
"description": "Page width."
}
},
"required": [
"height",
"width"
]
}
]
},
"page-type": {
"allOf": [
{
"$ref": "#/$defs/page-size-type"
},
{
"properties": {
"blank-pages": {
"default": false,
"description": "Mark blank pages with ",
"type": "boolean"
},
"body-column-count": {
"default": 1,
"description": "Column count on content pages.",
"type": "integer"
},
"bottom": {
"$ref": "#/$defs/length-type",
"default": "20mm",
"description": "Page bottom margin."
},
"column-gap": {
"$ref": "#/$defs/length-type",
"description": "Column gap on multi column pages."
},
"force-count": {
"default": "auto",
"description": "Force chapter to end on even or odd pages.",
"enum": [
"auto",
"even",
"odd"
],
"type": "string"
},
"index-column-count": {
"default": 2,
"description": "Column count on index pages.",
"type": "integer"
},
"inside": {
"$ref": "#/$defs/length-type",
"default": "20mm",
"description": "Page inside margin."
},
"mirror-margins": {
"default": false,
"description": "Duplex pages with recto and verso pages.",
"type": "boolean"
},
"outside": {
"$ref": "#/$defs/length-type",
"default": "20mm",
"description": "Page outside margin."
},
"top": {
"$ref": "#/$defs/length-type",
"default": "20mm",
"description": "Page top margin."
}
}
}
],
"description": "Page configuration.",
"examples": [
{
"bottom": "20mm",
"height": "297mm",
"inside": "30mm",
"outside": "20mm",
"top": "20mm",
"width": "210mm"
}
]
},
"section-type": {
"$ref": "#/$defs/body-type",
"properties": {
"title": {
"$ref": "#/$defs/body-type"
}
}
},
"style-type": {
"allOf": [
{
"properties": {
"apiname": {
"$ref": "#/$defs/inline-style-type"
},
"b": {
"$ref": "#/$defs/inline-style-type"
},
"body": {
"$ref": "#/$defs/body-type"
},
"cmdname": {
"$ref": "#/$defs/inline-style-type"
},
"codeblock": {
"$ref": "#/$defs/codeblock-type"
},
"codeph": {
"$ref": "#/$defs/inline-style-type"
},
"cover": {
"$ref": "#/$defs/block-style-type",
"properties": {
"image-metadata": {
"default": null,
"description": "Name of metadata element to use as cover image.",
"type": "string"
},
"image-topic": {
"default": null,
"description": "Outputclass for cover topic.",
"type": "string"
},
"title": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/content-type"
}
]
}
}
},
"delim": {
"$ref": "#/$defs/inline-style-type"
},
"dl": {
"$ref": "#/$defs/dl-type"
},
"example": {
"$ref": "#/$defs/section-type"
},
"fig": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/caption-type"
}
]
},
"filepath": {
"$ref": "#/$defs/inline-style-type"
},
"fragment": {
"$ref": "#/$defs/inline-style-type"
},
"fragref": {
"$ref": "#/$defs/inline-style-type"
},
"groupchoice": {
"$ref": "#/$defs/inline-style-type"
},
"groupcomp": {
"$ref": "#/$defs/inline-style-type"
},
"groupseq": {
"$ref": "#/$defs/inline-style-type"
},
"h1": {
"$ref": "#/$defs/topic-type"
},
"h2": {
"$ref": "#/$defs/topic-type"
},
"h3": {
"$ref": "#/$defs/topic-type"
},
"h4": {
"$ref": "#/$defs/topic-type"
},
"i": {
"$ref": "#/$defs/inline-style-type"
},
"keyword": {
"$ref": "#/$defs/inline-style-type"
},
"kwd": {
"$ref": "#/$defs/inline-style-type"
},
"line-through": {
"$ref": "#/$defs/inline-style-type"
},
"link": {
"$ref": "#/$defs/link-type",
"properties": {
"external": {
"$ref": "#/$defs/content-type"
}
}
},
"markupname": {
"$ref": "#/$defs/inline-style-type"
},
"menucascade": {
"$ref": "#/$defs/inline-style-type"
},
"note": {
"$ref": "#/$defs/note-type",
"properties": {
"attention": {
"$ref": "#/$defs/note-type"
},
"caution": {
"$ref": "#/$defs/note-type"
},
"danger": {
"$ref": "#/$defs/note-type"
},
"fastpath": {
"$ref": "#/$defs/note-type"
},
"important": {
"$ref": "#/$defs/note-type"
},
"note": {
"$ref": "#/$defs/note-type"
},
"notice": {
"$ref": "#/$defs/note-type"
},
"other": {
"$ref": "#/$defs/note-type"
},
"remember": {
"$ref": "#/$defs/note-type"
},
"restriction": {
"$ref": "#/$defs/note-type"
},
"tip": {
"$ref": "#/$defs/note-type"
},
"trouble": {
"$ref": "#/$defs/note-type"
},
"warning": {
"$ref": "#/$defs/note-type"
}
}
},
"numcharref": {
"$ref": "#/$defs/inline-style-type"
},
"ol": {
"$ref": "#/$defs/ol-type"
},
"oper": {
"$ref": "#/$defs/inline-style-type"
},
"option": {
"$ref": "#/$defs/inline-style-type"
},
"overline": {
"$ref": "#/$defs/inline-style-type"
},
"parameterentity": {
"$ref": "#/$defs/inline-style-type"
},
"parmname": {
"$ref": "#/$defs/inline-style-type"
},
"pre": {
"$ref": "#/$defs/body-type"
},
"repsep": {
"$ref": "#/$defs/inline-style-type"
},
"screen": {
"$ref": "#/$defs/inline-style-type"
},
"section": {
"$ref": "#/$defs/section-type"
},
"sep": {
"$ref": "#/$defs/inline-style-type"
},
"shortcut": {
"$ref": "#/$defs/inline-style-type"
},
"shortdesc": {
"$ref": "#/$defs/block-style-type"
},
"sub": {
"$ref": "#/$defs/inline-style-type"
},
"sup": {
"$ref": "#/$defs/inline-style-type"
},
"synblk": {
"$ref": "#/$defs/inline-style-type"
},
"synnote": {
"$ref": "#/$defs/inline-style-type"
},
"synnoteref": {
"$ref": "#/$defs/inline-style-type"
},
"synph": {
"$ref": "#/$defs/inline-style-type"
},
"syntaxdiagram": {
"$ref": "#/$defs/inline-style-type"
},
"systemoutput": {
"$ref": "#/$defs/inline-style-type"
},
"table": {
"$ref": "#/$defs/table-type",
"properties": {
"caption": {
"$ref": "#/$defs/block-style-type"
},
"entry": {
"$ref": "#/$defs/block-style-type"
},
"header": {
"$ref": "#/$defs/block-style-type"
}
}
},
"term": {
"$ref": "#/$defs/inline-style-type"
},
"textentity": {
"$ref": "#/$defs/inline-style-type"
},
"tm": {
"$ref": "#/$defs/tm-type"
},
"toc-1": {
"$ref": "#/$defs/toc-1-type"
},
"toc-2": {
"$ref": "#/$defs/body-type"
},
"toc-3": {
"$ref": "#/$defs/body-type"
},
"toc-4": {
"$ref": "#/$defs/body-type"
},
"tt": {
"$ref": "#/$defs/inline-style-type"
},
"u": {
"$ref": "#/$defs/inline-style-type"
},
"uicontrol": {
"$ref": "#/$defs/inline-style-type"
},
"ul": {
"$ref": "#/$defs/ul-type"
},
"userinput": {
"$ref": "#/$defs/inline-style-type"
},
"var": {
"$ref": "#/$defs/inline-style-type"
},
"varname": {
"$ref": "#/$defs/inline-style-type"
},
"wintitle": {
"$ref": "#/$defs/inline-style-type"
},
"xmlatt": {
"$ref": "#/$defs/inline-style-type"
},
"xmlelement": {
"$ref": "#/$defs/inline-style-type"
},
"xmlnsname": {
"$ref": "#/$defs/inline-style-type"
},
"xmlpi": {
"$ref": "#/$defs/inline-style-type"
}
}
}
]
},
"table-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/caption-type"
}
],
"properties": {
"table-continued": {
"default": false,
"description": "Generate 'Table continued' on page break within table.",
"type": "boolean"
}
}
},
"tm-type": {
"$ref": "#/$defs/inline-style-type",
"properties": {
"symbol-scope": {
"type": "string"
}
}
},
"toc-1-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"prefix": {
"type": "boolean"
}
}
},
"topic-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"title-numbering": {
"description": "Generate title numbering.",
"type": "boolean"
}
}
},
"ul-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"ul-1": {
"type": "string"
},
"ul-2": {
"type": "string"
},
"ul-3": {
"type": "string"
},
"ul-4": {
"type": "string"
}
}
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"default": "Theme template.",
"properties": {
"$schema": {
"type": "string"
},
"bookmark-style": {
"default": "COLLAPSED",
"description": "Expand state of PDF bookmarks.",
"enum": [
"COLLAPSED",
"EXPANDED"
],
"type": "string"
},
"chapter-layout": {
"default": "MINITOC",
"description": "Generate TOC for section.",
"enum": [
"MINITOC",
"BASIC"
],
"type": "string"
},
"extends": {
"description": "Extend another theme. Value is a URI to the theme to be extended.",
"type": "string"
},
"footer": {
"$ref": "#/$defs/header-type",
"description": "Page footer configuration."
},
"header": {
"$ref": "#/$defs/header-type",
"description": "Page header configuration."
},
"include-related-links": {
"default": "nofamily",
"description": "Specifies which link types are used to generate related links.",
"enum": [
"none",
"all",
"nofamily"
],
"type": "string"
},
"page": {
"$ref": "#/$defs/page-type",
"description": "Page configuration."
},
"page-number": {
"default": "page",
"description": "Generate page numbers with chapter number.",
"enum": [
"page",
"chapter-page"
],
"type": "string"
},
"style": {
"$ref": "#/$defs/style-type",
"description": "Style configuration."
},
"task-label": {
"default": false,
"description": "Generate labels for task sections.",
"type": "boolean"
},
"toc-maximum-level": {
"default": 4,
"description": "Maximum TOC depth.",
"type": "integer"
}
}
} | Apache-2.0 | en |
jelovirt/pdf-generator | 31c38bc808fe0f214432b3088a2f074b6e3a11ec | 2023-02-16T16:17:00 | src/main/resources/schema.json | 12 | 2024-05-28T04:36:36.069549Z | {
"$defs": {
"block-style-type": {
"properties": {
"background-color": {
"$ref": "#/$defs/colour-type"
},
"border-after-color": {
"$ref": "#/$defs/colour-type"
},
"border-after-style": {
"$ref": "#/$defs/border-style-type"
},
"border-after-width": {
"$ref": "#/$defs/length-type"
},
"border-before-color": {
"$ref": "#/$defs/colour-type"
},
"border-before-style": {
"$ref": "#/$defs/border-style-type"
},
"border-before-width": {
"$ref": "#/$defs/length-type"
},
"border-end-color": {
"$ref": "#/$defs/colour-type"
},
"border-end-style": {
"$ref": "#/$defs/border-style-type"
},
"border-end-width": {
"$ref": "#/$defs/length-type"
},
"border-start-color": {
"$ref": "#/$defs/colour-type"
},
"border-start-style": {
"$ref": "#/$defs/border-style-type"
},
"border-start-width": {
"$ref": "#/$defs/length-type"
},
"color": {
"$ref": "#/$defs/colour-type"
},
"end-indent": {
"$ref": "#/$defs/length-type"
},
"font-family": {
"type": "string"
},
"font-size": {
"$ref": "#/$defs/length-type"
},
"font-style": {
"type": "string"
},
"font-weight": {
"$ref": "#/$defs/font-weight-type"
},
"line-height": {
"$ref": "#/$defs/length-type"
},
"padding-after": {
"$ref": "#/$defs/length-type"
},
"padding-before": {
"$ref": "#/$defs/length-type"
},
"padding-end": {
"$ref": "#/$defs/length-type"
},
"padding-start": {
"$ref": "#/$defs/length-type"
},
"space-after": {
"$ref": "#/$defs/length-type"
},
"space-before": {
"$ref": "#/$defs/length-type"
},
"start-indent": {
"$ref": "#/$defs/length-type"
},
"text-align": {
"type": "string"
},
"text-decoration": {
"type": "string"
}
}
},
"body-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
}
],
"properties": {}
},
"border-style-type": {
"enum": [
"none",
"hidden",
"dotted",
"dashed",
"solid",
"double",
"groove",
"ridge",
"inset",
"outset",
"inherit"
],
"type": "string"
},
"caption-type": {
"properties": {
"caption-number": {
"description": "Number captions.",
"enum": [
"chapter",
"document",
"none"
],
"type": "string"
},
"caption-position": {
"description": "Caption position.",
"enum": [
"after",
"before"
],
"type": "string"
}
}
},
"codeblock-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
}
],
"properties": {
"caption-number": {
"description": "Number figures with chapter prefix or use whole document numbering.",
"enum": [
"chapter",
"document"
],
"type": "string"
},
"caption-position": {
"description": "Place figure caption before or after figure.",
"enum": [
"before",
"after"
],
"type": "string"
},
"line-numbering": {
"description": "Show line numbers.",
"type": "boolean"
},
"show-whitespace": {
"description": "Show whitespace characters.",
"type": "boolean"
}
}
},
"colour-type": {
"pattern": "^(#[a-eA-E0-9]{6}|#[a-eA-E0-9]{3}|rgb\\(\\d+,\\d+,\\d+\\)|rgb\\(\\d+%,\\d+%,\\d+%\\)|transparent|aqua|black|blue|cyan|fuchsia|gray|green|lime|maroon|navy|olive|orange|pink|purple|red|silver|teal|white|yellow|inherit)$",
"type": "string"
},
"content-array-type": {
"allOf": [
{
"properties": {
"kind": {
"description": "Type of content block.",
"enum": [
"field"
],
"type": "string"
},
"value": {
"description": "Field name.",
"enum": [
"title",
"chapter",
"folio",
"folio-with-total"
],
"type": "string"
}
}
},
{
"properties": {
"kind": {
"description": "Type of content block.",
"enum": [
"text"
],
"type": "string"
},
"value": {
"description": "Text content of block.",
"type": "string"
}
}
}
],
"description": "Header or footer contents. This is the parsed form of contents template.",
"examples": [
[
{
"kind": "field",
"value": "title"
},
{
"kind": "text",
"value": " \u2014 "
},
{
"kind": "field",
"value": "chapter"
}
]
],
"minItems": 0,
"type": "array"
},
"content-template-type": {
"description": "Header or footer contents template.",
"examples": [
"{title} \u2014 {chapter}"
],
"type": "string"
},
"content-type": {
"properties": {
"content": {
"anyOf": [
{
"$ref": "#/$defs/content-template-type"
},
{
"$ref": "#/$defs/content-array-type"
}
]
}
}
},
"dl-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
}
],
"properties": {
"dl-type": {
"description": "Definition list output style.",
"enum": [
"html",
"table",
"list"
],
"type": "string"
}
}
},
"font-weight-type": {
"enum": [
"normal",
"bold",
"bolder",
"lighter",
"100",
"200",
"300",
"400",
"500",
"600",
"700",
"800",
"900",
"inherit"
],
"type": "string"
},
"header-type": {
"description": "Page header and footer configuration.",
"properties": {
"even": {
"allOf": [
{
"$ref": "#/$defs/odd-type"
}
],
"description": "Header or footer on recto pages."
},
"odd": {
"allOf": [
{
"$ref": "#/$defs/odd-type"
}
],
"description": "Header or footer on verso pages."
}
}
},
"inline-style-type": {
"properties": {
"background-color": {
"$ref": "#/$defs/colour-type"
},
"color": {
"$ref": "#/$defs/colour-type"
},
"font-family": {
"type": "string"
},
"font-size": {
"$ref": "#/$defs/length-type"
},
"font-style": {
"enum": [
"normal",
"italic",
"oblique",
"backslant",
"inherit"
],
"type": "string"
},
"font-weight": {
"$ref": "#/$defs/font-weight-type"
},
"line-height": {
"$ref": "#/$defs/length-type"
},
"text-decoration": {
"type": "string"
}
}
},
"label-type": {
"properties": {
"label": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/content-type"
}
]
}
}
},
"length-type": {
"pattern": "^-?\\d+(\\.\\d+)?(cm|mm|in|pt|pc|px|em)?$",
"type": "string"
},
"link-type": {
"allOf": [
{
"$ref": "#/$defs/inline-style-type"
}
],
"properties": {
"link-page-number": {
"description": "Generate page number to internal links.",
"type": "boolean"
}
}
},
"note-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/label-type"
}
]
},
"odd-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/content-type"
}
]
},
"ol-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
}
],
"properties": {
"ol-1": {
"type": "string"
},
"ol-2": {
"type": "string"
},
"ol-3": {
"type": "string"
},
"ol-4": {
"type": "string"
},
"ol-after-1": {
"type": "string"
},
"ol-after-2": {
"type": "string"
},
"ol-after-3": {
"type": "string"
},
"ol-after-4": {
"type": "string"
}
}
},
"page-size-type": {
"oneOf": [
{
"properties": {
"orientation": {
"default": "portrait",
"description": "Page orientation.",
"enum": [
"portrait",
"letter"
],
"type": "string"
},
"size": {
"default": "Letter",
"description": "Page size.",
"enum": [
"A3",
"A4",
"A5",
"Executive",
"JIS B5",
"Tabloid",
"Legal",
"Letter",
"PA4"
],
"type": "string"
}
},
"required": [
"size"
]
},
{
"properties": {
"height": {
"allOf": [
{
"$ref": "#/$defs/length-type"
}
],
"default": "11in",
"description": "Page height."
},
"width": {
"allOf": [
{
"$ref": "#/$defs/length-type"
}
],
"default": "8.5in",
"description": "Page width."
}
},
"required": [
"height",
"width"
]
}
]
},
"page-type": {
"allOf": [
{
"$ref": "#/$defs/page-size-type"
},
{
"properties": {
"blank-pages": {
"default": false,
"description": "Mark blank pages with ",
"type": "boolean"
},
"body-column-count": {
"default": 1,
"description": "Column count on content pages.",
"type": "integer"
},
"bottom": {
"allOf": [
{
"$ref": "#/$defs/length-type"
}
],
"default": "20mm",
"description": "Page bottom margin."
},
"column-gap": {
"allOf": [
{
"$ref": "#/$defs/length-type"
}
],
"description": "Column gap on multi column pages."
},
"force-count": {
"default": "auto",
"description": "Force chapter to end on even or odd pages.",
"enum": [
"auto",
"even",
"odd"
],
"type": "string"
},
"index-column-count": {
"default": 2,
"description": "Column count on index pages.",
"type": "integer"
},
"inside": {
"allOf": [
{
"$ref": "#/$defs/length-type"
}
],
"default": "20mm",
"description": "Page inside margin."
},
"mirror-margins": {
"default": false,
"description": "Duplex pages with recto and verso pages.",
"type": "boolean"
},
"outside": {
"allOf": [
{
"$ref": "#/$defs/length-type"
}
],
"default": "20mm",
"description": "Page outside margin."
},
"top": {
"allOf": [
{
"$ref": "#/$defs/length-type"
}
],
"default": "20mm",
"description": "Page top margin."
}
}
}
],
"description": "Page configuration.",
"examples": [
{
"bottom": "20mm",
"height": "297mm",
"inside": "30mm",
"outside": "20mm",
"top": "20mm",
"width": "210mm"
}
]
},
"section-type": {
"allOf": [
{
"$ref": "#/$defs/body-type"
}
],
"properties": {
"title": {
"$ref": "#/$defs/body-type"
}
}
},
"style-type": {
"allOf": [
{
"properties": {
"apiname": {
"$ref": "#/$defs/inline-style-type"
},
"b": {
"$ref": "#/$defs/inline-style-type"
},
"body": {
"$ref": "#/$defs/body-type"
},
"cmdname": {
"$ref": "#/$defs/inline-style-type"
},
"codeblock": {
"$ref": "#/$defs/codeblock-type"
},
"codeph": {
"$ref": "#/$defs/inline-style-type"
},
"cover": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"properties": {
"image-metadata": {
"default": null,
"description": "Name of metadata element to use as cover image.",
"type": "string"
},
"image-topic": {
"default": null,
"description": "Outputclass for cover topic.",
"type": "string"
},
"title": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/content-type"
}
]
}
}
}
]
},
"delim": {
"$ref": "#/$defs/inline-style-type"
},
"dl": {
"$ref": "#/$defs/dl-type"
},
"example": {
"$ref": "#/$defs/section-type"
},
"fig": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/caption-type"
}
]
},
"filepath": {
"$ref": "#/$defs/inline-style-type"
},
"fragment": {
"$ref": "#/$defs/inline-style-type"
},
"fragref": {
"$ref": "#/$defs/inline-style-type"
},
"groupchoice": {
"$ref": "#/$defs/inline-style-type"
},
"groupcomp": {
"$ref": "#/$defs/inline-style-type"
},
"groupseq": {
"$ref": "#/$defs/inline-style-type"
},
"h1": {
"$ref": "#/$defs/topic-type"
},
"h2": {
"$ref": "#/$defs/topic-type"
},
"h3": {
"$ref": "#/$defs/topic-type"
},
"h4": {
"$ref": "#/$defs/topic-type"
},
"i": {
"$ref": "#/$defs/inline-style-type"
},
"keyword": {
"$ref": "#/$defs/inline-style-type"
},
"kwd": {
"$ref": "#/$defs/inline-style-type"
},
"line-through": {
"$ref": "#/$defs/inline-style-type"
},
"link": {
"allOf": [
{
"$ref": "#/$defs/link-type"
}
],
"properties": {
"external": {
"allOf": [
{
"$ref": "#/$defs/content-type"
}
]
}
}
},
"markupname": {
"$ref": "#/$defs/inline-style-type"
},
"menucascade": {
"$ref": "#/$defs/inline-style-type"
},
"note": {
"allOf": [
{
"$ref": "#/$defs/note-type"
},
{
"properties": {
"attention": {
"$ref": "#/$defs/note-type"
},
"caution": {
"$ref": "#/$defs/note-type"
},
"danger": {
"$ref": "#/$defs/note-type"
},
"fastpath": {
"$ref": "#/$defs/note-type"
},
"important": {
"$ref": "#/$defs/note-type"
},
"note": {
"$ref": "#/$defs/note-type"
},
"notice": {
"$ref": "#/$defs/note-type"
},
"other": {
"$ref": "#/$defs/note-type"
},
"remember": {
"$ref": "#/$defs/note-type"
},
"restriction": {
"$ref": "#/$defs/note-type"
},
"tip": {
"$ref": "#/$defs/note-type"
},
"trouble": {
"$ref": "#/$defs/note-type"
},
"warning": {
"$ref": "#/$defs/note-type"
}
}
}
]
},
"numcharref": {
"$ref": "#/$defs/inline-style-type"
},
"ol": {
"$ref": "#/$defs/ol-type"
},
"oper": {
"$ref": "#/$defs/inline-style-type"
},
"option": {
"$ref": "#/$defs/inline-style-type"
},
"overline": {
"$ref": "#/$defs/inline-style-type"
},
"parameterentity": {
"$ref": "#/$defs/inline-style-type"
},
"parmname": {
"$ref": "#/$defs/inline-style-type"
},
"pre": {
"$ref": "#/$defs/body-type"
},
"repsep": {
"$ref": "#/$defs/inline-style-type"
},
"screen": {
"$ref": "#/$defs/inline-style-type"
},
"section": {
"$ref": "#/$defs/section-type"
},
"sep": {
"$ref": "#/$defs/inline-style-type"
},
"shortcut": {
"$ref": "#/$defs/inline-style-type"
},
"shortdesc": {},
"sub": {
"$ref": "#/$defs/inline-style-type"
},
"sup": {
"$ref": "#/$defs/inline-style-type"
},
"synblk": {
"$ref": "#/$defs/inline-style-type"
},
"synnote": {
"$ref": "#/$defs/inline-style-type"
},
"synnoteref": {
"$ref": "#/$defs/inline-style-type"
},
"synph": {
"$ref": "#/$defs/inline-style-type"
},
"syntaxdiagram": {
"$ref": "#/$defs/inline-style-type"
},
"systemoutput": {
"$ref": "#/$defs/inline-style-type"
},
"table": {
"allOf": [
{
"$ref": "#/$defs/table-type"
}
],
"properties": {
"caption": {
"$ref": "#/$defs/block-style-type"
},
"header": {
"$ref": "#/$defs/block-style-type"
}
}
},
"term": {
"$ref": "#/$defs/inline-style-type"
},
"textentity": {
"$ref": "#/$defs/inline-style-type"
},
"tm": {
"$ref": "#/$defs/tm-type"
},
"toc-1": {
"$ref": "#/$defs/toc-1-type"
},
"toc-2": {
"$ref": "#/$defs/body-type"
},
"toc-3": {
"$ref": "#/$defs/body-type"
},
"toc-4": {
"$ref": "#/$defs/body-type"
},
"tt": {
"$ref": "#/$defs/inline-style-type"
},
"u": {
"$ref": "#/$defs/inline-style-type"
},
"uicontrol": {
"$ref": "#/$defs/inline-style-type"
},
"ul": {
"$ref": "#/$defs/ul-type"
},
"userinput": {
"$ref": "#/$defs/inline-style-type"
},
"var": {
"$ref": "#/$defs/inline-style-type"
},
"varname": {
"$ref": "#/$defs/inline-style-type"
},
"wintitle": {
"$ref": "#/$defs/inline-style-type"
},
"xmlatt": {
"$ref": "#/$defs/inline-style-type"
},
"xmlelement": {
"$ref": "#/$defs/inline-style-type"
},
"xmlnsname": {
"$ref": "#/$defs/inline-style-type"
},
"xmlpi": {
"$ref": "#/$defs/inline-style-type"
}
}
}
]
},
"table-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/caption-type"
}
],
"properties": {
"table-continued": {
"default": false,
"description": "Generate 'Table continued' on page break within table.",
"type": "boolean"
}
}
},
"tm-type": {
"allOf": [
{
"$ref": "#/$defs/inline-style-type"
}
],
"properties": {
"symbol-scope": {
"type": "string"
}
}
},
"toc-1-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
}
],
"properties": {
"prefix": {
"type": "boolean"
}
}
},
"topic-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
}
],
"properties": {
"title-numbering": {
"description": "Generate title numbering.",
"type": "boolean"
}
}
},
"ul-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
}
],
"properties": {
"ul-1": {
"type": "string"
},
"ul-2": {
"type": "string"
},
"ul-3": {
"type": "string"
},
"ul-4": {
"type": "string"
}
}
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"default": "Theme template.",
"properties": {
"$schema": {
"type": "string"
},
"bookmark-style": {
"default": "COLLAPSED",
"description": "Expand state of PDF bookmarks.",
"enum": [
"COLLAPSED",
"EXPANDED"
],
"type": "string"
},
"chapter-layout": {
"default": "MINITOC",
"description": "Generate TOC for section.",
"enum": [
"MINITOC",
"BASIC"
],
"type": "string"
},
"extends": {
"description": "Extend another theme. Value is a URI to the theme to be extended.",
"type": "string"
},
"footer": {
"allOf": [
{
"$ref": "#/$defs/header-type"
}
],
"description": "Page footer configuration."
},
"header": {
"allOf": [
{
"$ref": "#/$defs/header-type"
}
],
"description": "Page header configuration."
},
"include-related-links": {
"default": "nofamily",
"description": "Specifies which link types are used to generate related links.",
"enum": [
"none",
"all",
"nofamily"
],
"type": "string"
},
"page": {
"allOf": [
{
"$ref": "#/$defs/page-type"
}
],
"description": "Page configuration."
},
"page-number": {
"default": "page",
"description": "Generate page numbers with chapter number.",
"enum": [
"page",
"chapter-page"
],
"type": "string"
},
"style": {
"allOf": [
{
"$ref": "#/$defs/style-type"
}
],
"description": "Style configuration."
},
"task-label": {
"default": false,
"description": "Generate labels for task sections.",
"type": "boolean"
},
"toc-maximum-level": {
"default": 4,
"description": "Maximum TOC depth.",
"type": "integer"
}
}
} | Apache-2.0 | en |
jelovirt/pdf-generator | 5ff4cdb2743f97bc5b721ac029bf4efa615f354d | 2023-02-16T16:17:00 | src/main/resources/schema.json | 12 | 2024-05-28T04:36:36.069549Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"default": "Theme template.",
"definitions": {
"block-style-type": {
"properties": {
"background-color": {
"$ref": "#/definitions/colour-type"
},
"border-after-color": {
"$ref": "#/definitions/colour-type"
},
"border-after-style": {
"$ref": "#/definitions/border-style-type"
},
"border-after-width": {
"$ref": "#/definitions/length-type"
},
"border-before-color": {
"$ref": "#/definitions/colour-type"
},
"border-before-style": {
"$ref": "#/definitions/border-style-type"
},
"border-before-width": {
"$ref": "#/definitions/length-type"
},
"border-end-color": {
"$ref": "#/definitions/colour-type"
},
"border-end-style": {
"$ref": "#/definitions/border-style-type"
},
"border-end-width": {
"$ref": "#/definitions/length-type"
},
"border-start-color": {
"$ref": "#/definitions/colour-type"
},
"border-start-style": {
"$ref": "#/definitions/border-style-type"
},
"border-start-width": {
"$ref": "#/definitions/length-type"
},
"color": {
"$ref": "#/definitions/colour-type"
},
"end-indent": {
"$ref": "#/definitions/length-type"
},
"font-family": {
"type": "string"
},
"font-size": {
"$ref": "#/definitions/length-type"
},
"font-style": {
"type": "string"
},
"font-weight": {
"$ref": "#/definitions/font-weight-type"
},
"line-height": {
"$ref": "#/definitions/length-type"
},
"padding-after": {
"$ref": "#/definitions/length-type"
},
"padding-before": {
"$ref": "#/definitions/length-type"
},
"padding-end": {
"$ref": "#/definitions/length-type"
},
"padding-start": {
"$ref": "#/definitions/length-type"
},
"space-after": {
"$ref": "#/definitions/length-type"
},
"space-before": {
"$ref": "#/definitions/length-type"
},
"start-indent": {
"$ref": "#/definitions/length-type"
},
"text-align": {
"type": "string"
},
"text-decoration": {
"type": "string"
}
}
},
"body-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {}
},
"border-style-type": {
"enum": [
"none",
"hidden",
"dotted",
"dashed",
"solid",
"double",
"groove",
"ridge",
"inset",
"outset",
"inherit"
],
"type": "string"
},
"caption-type": {
"properties": {
"caption-number": {
"description": "Number captions.",
"enum": [
"chapter",
"document",
"none"
],
"type": "string"
},
"caption-position": {
"description": "Caption position.",
"enum": [
"after",
"before"
],
"type": "string"
}
}
},
"codeblock-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"caption-number": {
"description": "Number figures with chapter prefix or use whole document numbering.",
"enum": [
"chapter",
"document"
],
"type": "string"
},
"caption-position": {
"description": "Place figure caption before or after figure.",
"enum": [
"before",
"after"
],
"type": "string"
},
"line-numbering": {
"description": "Show line numbers.",
"type": "boolean"
},
"show-whitespace": {
"description": "Show whitespace characters.",
"type": "boolean"
}
}
},
"colour-type": {
"pattern": "^(#[a-eA-E0-9]{6}|#[a-eA-E0-9]{3}|rgb\\(\\d+,\\d+,\\d+\\)|rgb\\(\\d+%,\\d+%,\\d+%\\)|transparent|aqua|black|blue|cyan|fuchsia|gray|green|lime|maroon|navy|olive|orange|pink|purple|red|silver|teal|white|yellow|inherit)$",
"type": "string"
},
"content-array-type": {
"allOf": [
{
"properties": {
"kind": {
"description": "Type of content block.",
"enum": [
"field"
],
"type": "string"
},
"value": {
"description": "Field name.",
"enum": [
"title",
"chapter",
"folio",
"folio-with-total"
],
"type": "string"
}
}
},
{
"properties": {
"kind": {
"description": "Type of content block.",
"enum": [
"text"
],
"type": "string"
},
"value": {
"description": "Text content of block.",
"type": "string"
}
}
}
],
"description": "Header or footer contents. This is the parsed form of contents template.",
"examples": [
[
{
"kind": "field",
"value": "title"
},
{
"kind": "text",
"value": " \u2014 "
},
{
"kind": "field",
"value": "chapter"
}
]
],
"minItems": 0,
"type": "array"
},
"content-template-type": {
"description": "Header or footer contents template.",
"examples": [
"{title} \u2014 {chapter}"
],
"type": "string"
},
"content-type": {
"properties": {
"content": {
"anyOf": [
{
"$ref": "#/definitions/content-template-type"
},
{
"$ref": "#/definitions/content-array-type"
}
]
}
}
},
"dl-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"dl-type": {
"description": "Definition list output style.",
"enum": [
"html",
"table",
"list"
],
"type": "string"
}
}
},
"font-weight-type": {
"enum": [
"normal",
"bold",
"bolder",
"lighter",
"100",
"200",
"300",
"400",
"500",
"600",
"700",
"800",
"900",
"inherit"
],
"type": "string"
},
"header-type": {
"description": "Page header and footer configuration.",
"properties": {
"even": {
"allOf": [
{
"$ref": "#/definitions/odd-type"
}
],
"description": "Header or footer on recto pages."
},
"odd": {
"allOf": [
{
"$ref": "#/definitions/odd-type"
}
],
"description": "Header or footer on verso pages."
}
}
},
"inline-style-type": {
"properties": {
"background-color": {
"$ref": "#/definitions/colour-type"
},
"color": {
"$ref": "#/definitions/colour-type"
},
"font-family": {
"type": "string"
},
"font-size": {
"$ref": "#/definitions/length-type"
},
"font-style": {
"enum": [
"normal",
"italic",
"oblique",
"backslant",
"inherit"
],
"type": "string"
},
"font-weight": {
"$ref": "#/definitions/font-weight-type"
},
"line-height": {
"$ref": "#/definitions/length-type"
},
"text-decoration": {
"type": "string"
}
}
},
"label-type": {
"properties": {
"label": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/content-type"
}
]
}
}
},
"length-type": {
"pattern": "^-?\\d+(\\.\\d+)?(cm|mm|in|pt|pc|px|em)?$",
"type": "string"
},
"link-type": {
"allOf": [
{
"$ref": "#/definitions/inline-style-type"
}
],
"properties": {
"link-page-number": {
"description": "Generate page number to internal links.",
"type": "boolean"
}
}
},
"note-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/label-type"
}
]
},
"odd-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/content-type"
}
]
},
"ol-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"ol-1": {
"type": "string"
},
"ol-2": {
"type": "string"
},
"ol-3": {
"type": "string"
},
"ol-4": {
"type": "string"
},
"ol-after-1": {
"type": "string"
},
"ol-after-2": {
"type": "string"
},
"ol-after-3": {
"type": "string"
},
"ol-after-4": {
"type": "string"
}
}
},
"page-size-type": {
"oneOf": [
{
"properties": {
"orientation": {
"default": "portrait",
"description": "Page orientation.",
"enum": [
"portrait",
"letter"
],
"type": "string"
},
"size": {
"default": "Letter",
"description": "Page size.",
"enum": [
"A3",
"A4",
"A5",
"Executive",
"JIS B5",
"Tabloid",
"Legal",
"Letter",
"PA4"
],
"type": "string"
}
},
"required": [
"size"
]
},
{
"properties": {
"height": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "11in",
"description": "Page height."
},
"width": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "8.5in",
"description": "Page width."
}
},
"required": [
"height",
"width"
]
}
]
},
"page-type": {
"allOf": [
{
"$ref": "#/definitions/page-size-type"
},
{
"properties": {
"blank-pages": {
"default": false,
"description": "Mark blank pages with ",
"type": "boolean"
},
"body-column-count": {
"default": 1,
"description": "Column count on content pages.",
"type": "integer"
},
"bottom": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "20mm",
"description": "Page bottom margin."
},
"column-gap": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"description": "Column gap on multi column pages."
},
"force-count": {
"default": "auto",
"description": "Force chapter to end on even or odd pages.",
"enum": [
"auto",
"even",
"odd"
],
"type": "string"
},
"index-column-count": {
"default": 2,
"description": "Column count on index pages.",
"type": "integer"
},
"inside": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "20mm",
"description": "Page inside margin."
},
"mirror-margins": {
"default": false,
"description": "Duplex pages with recto and verso pages.",
"type": "boolean"
},
"outside": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "20mm",
"description": "Page outside margin."
},
"top": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "20mm",
"description": "Page top margin."
}
}
}
],
"description": "Page configuration.",
"examples": [
{
"bottom": "20mm",
"height": "297mm",
"inside": "30mm",
"outside": "20mm",
"top": "20mm",
"width": "210mm"
}
]
},
"section-type": {
"allOf": [
{
"$ref": "#/definitions/body-type"
}
],
"properties": {
"title": {
"$ref": "#/definitions/body-type"
}
}
},
"style-type": {
"allOf": [
{
"properties": {
"apiname": {
"$ref": "#/definitions/inline-style-type"
},
"b": {
"$ref": "#/definitions/inline-style-type"
},
"body": {
"$ref": "#/definitions/body-type"
},
"cmdname": {
"$ref": "#/definitions/inline-style-type"
},
"codeblock": {
"$ref": "#/definitions/codeblock-type"
},
"codeph": {
"$ref": "#/definitions/inline-style-type"
},
"cover": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"properties": {
"image-metadata": {
"default": null,
"description": "Name of metadata element to use as cover image.",
"type": "string"
},
"image-topic": {
"default": null,
"description": "Outputclass for cover topic.",
"type": "string"
},
"title": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/content-type"
}
]
}
}
}
]
},
"delim": {
"$ref": "#/definitions/inline-style-type"
},
"dl": {
"$ref": "#/definitions/dl-type"
},
"example": {
"$ref": "#/definitions/section-type"
},
"fig": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/caption-type"
}
]
},
"filepath": {
"$ref": "#/definitions/inline-style-type"
},
"fragment": {
"$ref": "#/definitions/inline-style-type"
},
"fragref": {
"$ref": "#/definitions/inline-style-type"
},
"groupchoice": {
"$ref": "#/definitions/inline-style-type"
},
"groupcomp": {
"$ref": "#/definitions/inline-style-type"
},
"groupseq": {
"$ref": "#/definitions/inline-style-type"
},
"h1": {
"$ref": "#/definitions/topic-type"
},
"h2": {
"$ref": "#/definitions/topic-type"
},
"h3": {
"$ref": "#/definitions/topic-type"
},
"h4": {
"$ref": "#/definitions/topic-type"
},
"i": {
"$ref": "#/definitions/inline-style-type"
},
"keyword": {
"$ref": "#/definitions/inline-style-type"
},
"kwd": {
"$ref": "#/definitions/inline-style-type"
},
"line-through": {
"$ref": "#/definitions/inline-style-type"
},
"link": {
"allOf": [
{
"$ref": "#/definitions/link-type"
}
],
"properties": {
"external": {
"allOf": [
{
"$ref": "#/definitions/content-type"
}
]
}
}
},
"markupname": {
"$ref": "#/definitions/inline-style-type"
},
"menucascade": {
"$ref": "#/definitions/inline-style-type"
},
"note": {
"allOf": [
{
"$ref": "#/definitions/note-type"
},
{
"properties": {
"attention": {
"$ref": "#/definitions/note-type"
},
"caution": {
"$ref": "#/definitions/note-type"
},
"danger": {
"$ref": "#/definitions/note-type"
},
"fastpath": {
"$ref": "#/definitions/note-type"
},
"important": {
"$ref": "#/definitions/note-type"
},
"note": {
"$ref": "#/definitions/note-type"
},
"notice": {
"$ref": "#/definitions/note-type"
},
"other": {
"$ref": "#/definitions/note-type"
},
"remember": {
"$ref": "#/definitions/note-type"
},
"restriction": {
"$ref": "#/definitions/note-type"
},
"tip": {
"$ref": "#/definitions/note-type"
},
"trouble": {
"$ref": "#/definitions/note-type"
},
"warning": {
"$ref": "#/definitions/note-type"
}
}
}
]
},
"numcharref": {
"$ref": "#/definitions/inline-style-type"
},
"ol": {
"$ref": "#/definitions/ol-type"
},
"oper": {
"$ref": "#/definitions/inline-style-type"
},
"option": {
"$ref": "#/definitions/inline-style-type"
},
"overline": {
"$ref": "#/definitions/inline-style-type"
},
"parameterentity": {
"$ref": "#/definitions/inline-style-type"
},
"parmname": {
"$ref": "#/definitions/inline-style-type"
},
"pre": {
"$ref": "#/definitions/body-type"
},
"repsep": {
"$ref": "#/definitions/inline-style-type"
},
"screen": {
"$ref": "#/definitions/inline-style-type"
},
"section": {
"$ref": "#/definitions/section-type"
},
"sep": {
"$ref": "#/definitions/inline-style-type"
},
"shortcut": {
"$ref": "#/definitions/inline-style-type"
},
"shortdesc": {},
"sub": {
"$ref": "#/definitions/inline-style-type"
},
"sup": {
"$ref": "#/definitions/inline-style-type"
},
"synblk": {
"$ref": "#/definitions/inline-style-type"
},
"synnote": {
"$ref": "#/definitions/inline-style-type"
},
"synnoteref": {
"$ref": "#/definitions/inline-style-type"
},
"synph": {
"$ref": "#/definitions/inline-style-type"
},
"syntaxdiagram": {
"$ref": "#/definitions/inline-style-type"
},
"systemoutput": {
"$ref": "#/definitions/inline-style-type"
},
"table": {
"allOf": [
{
"$ref": "#/definitions/table-type"
}
],
"properties": {
"caption": {
"$ref": "#/definitions/block-style-type"
},
"header": {
"$ref": "#/definitions/block-style-type"
}
}
},
"term": {
"$ref": "#/definitions/inline-style-type"
},
"textentity": {
"$ref": "#/definitions/inline-style-type"
},
"tm": {
"$ref": "#/definitions/tm-type"
},
"toc-1": {
"$ref": "#/definitions/toc-1-type"
},
"toc-2": {
"$ref": "#/definitions/body-type"
},
"toc-3": {
"$ref": "#/definitions/body-type"
},
"toc-4": {
"$ref": "#/definitions/body-type"
},
"tt": {
"$ref": "#/definitions/inline-style-type"
},
"u": {
"$ref": "#/definitions/inline-style-type"
},
"uicontrol": {
"$ref": "#/definitions/inline-style-type"
},
"ul": {
"$ref": "#/definitions/ul-type"
},
"userinput": {
"$ref": "#/definitions/inline-style-type"
},
"var": {
"$ref": "#/definitions/inline-style-type"
},
"varname": {
"$ref": "#/definitions/inline-style-type"
},
"wintitle": {
"$ref": "#/definitions/inline-style-type"
},
"xmlatt": {
"$ref": "#/definitions/inline-style-type"
},
"xmlelement": {
"$ref": "#/definitions/inline-style-type"
},
"xmlnsname": {
"$ref": "#/definitions/inline-style-type"
},
"xmlpi": {
"$ref": "#/definitions/inline-style-type"
}
}
}
]
},
"table-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/caption-type"
}
],
"properties": {
"table-continued": {
"default": false,
"description": "Generate 'Table continued' on page break within table.",
"type": "boolean"
}
}
},
"tm-type": {
"allOf": [
{
"$ref": "#/definitions/inline-style-type"
}
],
"properties": {
"symbol-scope": {
"type": "string"
}
}
},
"toc-1-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"prefix": {
"type": "boolean"
}
}
},
"topic-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"title-numbering": {
"description": "Generate title numbering.",
"type": "boolean"
}
}
},
"ul-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"ul-1": {
"type": "string"
},
"ul-2": {
"type": "string"
},
"ul-3": {
"type": "string"
},
"ul-4": {
"type": "string"
}
}
}
},
"properties": {
"$schema": {
"type": "string"
},
"bookmark-style": {
"default": "COLLAPSED",
"description": "Expand state of PDF bookmarks.",
"enum": [
"COLLAPSED",
"EXPANDED"
],
"type": "string"
},
"chapter-layout": {
"default": "MINITOC",
"description": "Generate TOC for section.",
"enum": [
"MINITOC",
"BASIC"
],
"type": "string"
},
"extends": {
"description": "Extend another theme. Value is a URI to the theme to be extended.",
"type": "string"
},
"footer": {
"allOf": [
{
"$ref": "#/definitions/header-type"
}
],
"description": "Page footer configuration."
},
"header": {
"allOf": [
{
"$ref": "#/definitions/header-type"
}
],
"description": "Page header configuration."
},
"include-related-links": {
"default": "nofamily",
"description": "Specifies which link types are used to generate related links.",
"enum": [
"none",
"all",
"nofamily"
],
"type": "string"
},
"page": {
"allOf": [
{
"$ref": "#/definitions/page-type"
}
],
"description": "Page configuration."
},
"page-number": {
"default": "page",
"description": "Generate page numbers with chapter number.",
"enum": [
"page",
"chapter-page"
],
"type": "string"
},
"style": {
"allOf": [
{
"$ref": "#/definitions/style-type"
}
],
"description": "Style configuration."
},
"task-label": {
"default": false,
"description": "Generate labels for task sections.",
"type": "boolean"
},
"toc-maximum-level": {
"default": 4,
"description": "Maximum TOC depth.",
"type": "integer"
}
}
} | Apache-2.0 | en |
jelovirt/pdf-generator | 6edf989893b94081dbcf81efc163e90ccedd36f1 | 2024-01-01T08:19:48 | src/main/resources/schema.json | 12 | 2024-05-28T04:36:36.069549Z | {
"$defs": {
"block-style-type": {
"properties": {
"background-color": {
"$ref": "#/$defs/colour-type"
},
"border-after-color": {
"$ref": "#/$defs/colour-type"
},
"border-after-style": {
"$ref": "#/$defs/border-style-type"
},
"border-after-width": {
"$ref": "#/$defs/length-type"
},
"border-before-color": {
"$ref": "#/$defs/colour-type"
},
"border-before-style": {
"$ref": "#/$defs/border-style-type"
},
"border-before-width": {
"$ref": "#/$defs/length-type"
},
"border-end-color": {
"$ref": "#/$defs/colour-type"
},
"border-end-style": {
"$ref": "#/$defs/border-style-type"
},
"border-end-width": {
"$ref": "#/$defs/length-type"
},
"border-start-color": {
"$ref": "#/$defs/colour-type"
},
"border-start-style": {
"$ref": "#/$defs/border-style-type"
},
"border-start-width": {
"$ref": "#/$defs/length-type"
},
"color": {
"$ref": "#/$defs/colour-type"
},
"end-indent": {
"$ref": "#/$defs/length-type"
},
"font-family": {
"type": "string"
},
"font-size": {
"$ref": "#/$defs/length-type"
},
"font-style": {
"type": "string"
},
"font-weight": {
"$ref": "#/$defs/font-weight-type"
},
"line-height": {
"$ref": "#/$defs/length-type"
},
"padding-after": {
"$ref": "#/$defs/length-type"
},
"padding-before": {
"$ref": "#/$defs/length-type"
},
"padding-end": {
"$ref": "#/$defs/length-type"
},
"padding-start": {
"$ref": "#/$defs/length-type"
},
"space-after": {
"$ref": "#/$defs/length-type"
},
"space-before": {
"$ref": "#/$defs/length-type"
},
"start-indent": {
"$ref": "#/$defs/length-type"
},
"text-align": {
"type": "string"
},
"text-decoration": {
"type": "string"
}
}
},
"body-type": {
"$ref": "#/$defs/block-style-type",
"properties": {}
},
"border-style-type": {
"enum": [
"none",
"hidden",
"dotted",
"dashed",
"solid",
"double",
"groove",
"ridge",
"inset",
"outset",
"inherit"
],
"type": "string"
},
"caption-type": {
"properties": {
"caption-number": {
"description": "Number captions.",
"enum": [
"chapter",
"document",
"none"
],
"type": "string"
},
"caption-position": {
"description": "Caption position.",
"enum": [
"after",
"before"
],
"type": "string"
}
}
},
"codeblock-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"caption-number": {
"description": "Number figures with chapter prefix or use whole document numbering.",
"enum": [
"chapter",
"document"
],
"type": "string"
},
"caption-position": {
"description": "Place figure caption before or after figure.",
"enum": [
"before",
"after"
],
"type": "string"
},
"line-numbering": {
"description": "Show line numbers.",
"type": "boolean"
},
"show-whitespace": {
"description": "Show whitespace characters.",
"type": "boolean"
}
}
},
"colour-type": {
"pattern": "^(#[a-eA-E0-9]{6}|#[a-eA-E0-9]{3}|rgb\\(\\d+,\\d+,\\d+\\)|rgb\\(\\d+%,\\d+%,\\d+%\\)|transparent|aqua|black|blue|cyan|fuchsia|gray|green|lime|maroon|navy|olive|orange|pink|purple|red|silver|teal|white|yellow|inherit)$",
"type": "string"
},
"content-array-type": {
"allOf": [
{
"properties": {
"kind": {
"description": "Type of content block.",
"enum": [
"field"
],
"type": "string"
},
"value": {
"description": "Field name.",
"enum": [
"title",
"chapter",
"folio",
"folio-with-total"
],
"type": "string"
}
}
},
{
"properties": {
"kind": {
"description": "Type of content block.",
"enum": [
"text"
],
"type": "string"
},
"value": {
"description": "Text content of block.",
"type": "string"
}
}
}
],
"description": "Header or footer contents. This is the parsed form of contents template.",
"examples": [
[
{
"kind": "field",
"value": "title"
},
{
"kind": "text",
"value": " \u2014 "
},
{
"kind": "field",
"value": "chapter"
}
]
],
"minItems": 0,
"type": "array"
},
"content-template-type": {
"description": "Header or footer contents template.",
"examples": [
"{title} \u2014 {chapter}"
],
"type": "string"
},
"content-type": {
"properties": {
"content": {
"anyOf": [
{
"$ref": "#/$defs/content-template-type"
},
{
"$ref": "#/$defs/content-array-type"
}
]
}
}
},
"dl-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"dl-type": {
"description": "Definition list output style.",
"enum": [
"html",
"table",
"list"
],
"type": "string"
}
}
},
"font-weight-type": {
"enum": [
"normal",
"bold",
"bolder",
"lighter",
"100",
"200",
"300",
"400",
"500",
"600",
"700",
"800",
"900",
"inherit"
],
"type": "string"
},
"header-type": {
"description": "Page header and footer configuration.",
"properties": {
"even": {
"$ref": "#/$defs/odd-type",
"description": "Header or footer on recto pages."
},
"odd": {
"$ref": "#/$defs/odd-type",
"description": "Header or footer on verso pages."
}
}
},
"inline-style-type": {
"properties": {
"background-color": {
"$ref": "#/$defs/colour-type"
},
"color": {
"$ref": "#/$defs/colour-type"
},
"font-family": {
"type": "string"
},
"font-size": {
"$ref": "#/$defs/length-type"
},
"font-style": {
"enum": [
"normal",
"italic",
"oblique",
"backslant",
"inherit"
],
"type": "string"
},
"font-weight": {
"$ref": "#/$defs/font-weight-type"
},
"line-height": {
"$ref": "#/$defs/length-type"
},
"text-decoration": {
"type": "string"
}
}
},
"label-type": {
"properties": {
"label": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/content-type"
}
]
}
}
},
"length-type": {
"pattern": "^-?\\d+(\\.\\d+)?(cm|mm|in|pt|pc|px|em)?$",
"type": "string"
},
"link-type": {
"$ref": "#/$defs/inline-style-type",
"properties": {
"link-page-number": {
"description": "Generate page number to internal links.",
"type": "boolean"
}
}
},
"note-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/label-type"
}
]
},
"odd-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/content-type"
}
]
},
"ol-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"ol-1": {
"type": "string"
},
"ol-2": {
"type": "string"
},
"ol-3": {
"type": "string"
},
"ol-4": {
"type": "string"
},
"ol-after-1": {
"type": "string"
},
"ol-after-2": {
"type": "string"
},
"ol-after-3": {
"type": "string"
},
"ol-after-4": {
"type": "string"
}
}
},
"page-size-type": {
"oneOf": [
{
"properties": {
"orientation": {
"default": "portrait",
"description": "Page orientation.",
"enum": [
"portrait",
"letter"
],
"type": "string"
},
"size": {
"default": "Letter",
"description": "Page size.",
"enum": [
"A3",
"A4",
"A5",
"Executive",
"JIS B5",
"Tabloid",
"Legal",
"Letter",
"PA4"
],
"type": "string"
}
},
"required": [
"size"
]
},
{
"properties": {
"height": {
"$ref": "#/$defs/length-type",
"default": "11in",
"description": "Page height."
},
"width": {
"$ref": "#/$defs/length-type",
"default": "8.5in",
"description": "Page width."
}
},
"required": [
"height",
"width"
]
}
]
},
"page-type": {
"allOf": [
{
"$ref": "#/$defs/page-size-type"
},
{
"properties": {
"blank-pages": {
"default": false,
"description": "Mark blank pages with ",
"type": "boolean"
},
"body-column-count": {
"default": 1,
"description": "Column count on content pages.",
"type": "integer"
},
"bottom": {
"$ref": "#/$defs/length-type",
"default": "20mm",
"description": "Page bottom margin."
},
"column-gap": {
"$ref": "#/$defs/length-type",
"description": "Column gap on multi column pages."
},
"force-count": {
"default": "auto",
"description": "Force chapter to end on even or odd pages.",
"enum": [
"auto",
"even",
"odd"
],
"type": "string"
},
"index-column-count": {
"default": 2,
"description": "Column count on index pages.",
"type": "integer"
},
"inside": {
"$ref": "#/$defs/length-type",
"default": "20mm",
"description": "Page inside margin."
},
"mirror-margins": {
"default": false,
"description": "Duplex pages with recto and verso pages.",
"type": "boolean"
},
"outside": {
"$ref": "#/$defs/length-type",
"default": "20mm",
"description": "Page outside margin."
},
"top": {
"$ref": "#/$defs/length-type",
"default": "20mm",
"description": "Page top margin."
}
}
}
],
"description": "Page configuration.",
"examples": [
{
"bottom": "20mm",
"height": "297mm",
"inside": "30mm",
"outside": "20mm",
"top": "20mm",
"width": "210mm"
}
]
},
"section-type": {
"$ref": "#/$defs/body-type",
"properties": {
"title": {
"$ref": "#/$defs/body-type"
}
}
},
"style-type": {
"allOf": [
{
"properties": {
"apiname": {
"$ref": "#/$defs/inline-style-type"
},
"b": {
"$ref": "#/$defs/inline-style-type"
},
"body": {
"$ref": "#/$defs/body-type"
},
"cmdname": {
"$ref": "#/$defs/inline-style-type"
},
"codeblock": {
"$ref": "#/$defs/codeblock-type"
},
"codeph": {
"$ref": "#/$defs/inline-style-type"
},
"cover": {
"$ref": "#/$defs/block-style-type",
"properties": {
"image-metadata": {
"default": null,
"description": "Name of metadata element to use as cover image.",
"type": "string"
},
"image-topic": {
"default": null,
"description": "Outputclass for cover topic.",
"type": "string"
},
"title": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/content-type"
}
]
},
"titlealt": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/content-type"
}
]
}
}
},
"delim": {
"$ref": "#/$defs/inline-style-type"
},
"dl": {
"$ref": "#/$defs/dl-type"
},
"example": {
"$ref": "#/$defs/section-type"
},
"fig": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/caption-type"
}
]
},
"filepath": {
"$ref": "#/$defs/inline-style-type"
},
"fragment": {
"$ref": "#/$defs/inline-style-type"
},
"fragref": {
"$ref": "#/$defs/inline-style-type"
},
"groupchoice": {
"$ref": "#/$defs/inline-style-type"
},
"groupcomp": {
"$ref": "#/$defs/inline-style-type"
},
"groupseq": {
"$ref": "#/$defs/inline-style-type"
},
"h1": {
"$ref": "#/$defs/topic-type"
},
"h2": {
"$ref": "#/$defs/topic-type"
},
"h3": {
"$ref": "#/$defs/topic-type"
},
"h4": {
"$ref": "#/$defs/topic-type"
},
"i": {
"$ref": "#/$defs/inline-style-type"
},
"keyword": {
"$ref": "#/$defs/inline-style-type"
},
"kwd": {
"$ref": "#/$defs/inline-style-type"
},
"line-through": {
"$ref": "#/$defs/inline-style-type"
},
"link": {
"$ref": "#/$defs/link-type",
"properties": {
"external": {
"$ref": "#/$defs/content-type"
}
}
},
"markupname": {
"$ref": "#/$defs/inline-style-type"
},
"menucascade": {
"$ref": "#/$defs/inline-style-type"
},
"note": {
"$ref": "#/$defs/note-type",
"properties": {
"attention": {
"$ref": "#/$defs/note-type"
},
"caution": {
"$ref": "#/$defs/note-type"
},
"danger": {
"$ref": "#/$defs/note-type"
},
"fastpath": {
"$ref": "#/$defs/note-type"
},
"important": {
"$ref": "#/$defs/note-type"
},
"note": {
"$ref": "#/$defs/note-type"
},
"notice": {
"$ref": "#/$defs/note-type"
},
"other": {
"$ref": "#/$defs/note-type"
},
"remember": {
"$ref": "#/$defs/note-type"
},
"restriction": {
"$ref": "#/$defs/note-type"
},
"tip": {
"$ref": "#/$defs/note-type"
},
"trouble": {
"$ref": "#/$defs/note-type"
},
"warning": {
"$ref": "#/$defs/note-type"
}
}
},
"numcharref": {
"$ref": "#/$defs/inline-style-type"
},
"ol": {
"$ref": "#/$defs/ol-type"
},
"oper": {
"$ref": "#/$defs/inline-style-type"
},
"option": {
"$ref": "#/$defs/inline-style-type"
},
"overline": {
"$ref": "#/$defs/inline-style-type"
},
"parameterentity": {
"$ref": "#/$defs/inline-style-type"
},
"parmname": {
"$ref": "#/$defs/inline-style-type"
},
"pre": {
"$ref": "#/$defs/body-type"
},
"repsep": {
"$ref": "#/$defs/inline-style-type"
},
"screen": {
"$ref": "#/$defs/inline-style-type"
},
"section": {
"$ref": "#/$defs/section-type"
},
"sep": {
"$ref": "#/$defs/inline-style-type"
},
"shortcut": {
"$ref": "#/$defs/inline-style-type"
},
"shortdesc": {
"$ref": "#/$defs/block-style-type"
},
"sub": {
"$ref": "#/$defs/inline-style-type"
},
"sup": {
"$ref": "#/$defs/inline-style-type"
},
"synblk": {
"$ref": "#/$defs/inline-style-type"
},
"synnote": {
"$ref": "#/$defs/inline-style-type"
},
"synnoteref": {
"$ref": "#/$defs/inline-style-type"
},
"synph": {
"$ref": "#/$defs/inline-style-type"
},
"syntaxdiagram": {
"$ref": "#/$defs/inline-style-type"
},
"systemoutput": {
"$ref": "#/$defs/inline-style-type"
},
"table": {
"$ref": "#/$defs/table-type",
"properties": {
"caption": {
"$ref": "#/$defs/block-style-type"
},
"entry": {
"$ref": "#/$defs/block-style-type"
},
"header": {
"$ref": "#/$defs/block-style-type"
}
}
},
"term": {
"$ref": "#/$defs/inline-style-type"
},
"textentity": {
"$ref": "#/$defs/inline-style-type"
},
"tm": {
"$ref": "#/$defs/tm-type"
},
"toc-1": {
"$ref": "#/$defs/toc-1-type"
},
"toc-2": {
"$ref": "#/$defs/body-type"
},
"toc-3": {
"$ref": "#/$defs/body-type"
},
"toc-4": {
"$ref": "#/$defs/body-type"
},
"tt": {
"$ref": "#/$defs/inline-style-type"
},
"u": {
"$ref": "#/$defs/inline-style-type"
},
"uicontrol": {
"$ref": "#/$defs/inline-style-type"
},
"ul": {
"$ref": "#/$defs/ul-type"
},
"userinput": {
"$ref": "#/$defs/inline-style-type"
},
"var": {
"$ref": "#/$defs/inline-style-type"
},
"varname": {
"$ref": "#/$defs/inline-style-type"
},
"wintitle": {
"$ref": "#/$defs/inline-style-type"
},
"xmlatt": {
"$ref": "#/$defs/inline-style-type"
},
"xmlelement": {
"$ref": "#/$defs/inline-style-type"
},
"xmlnsname": {
"$ref": "#/$defs/inline-style-type"
},
"xmlpi": {
"$ref": "#/$defs/inline-style-type"
}
}
}
]
},
"table-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/caption-type"
}
],
"properties": {
"table-continued": {
"default": false,
"description": "Generate 'Table continued' on page break within table.",
"type": "boolean"
}
}
},
"tm-type": {
"$ref": "#/$defs/inline-style-type",
"properties": {
"symbol-scope": {
"type": "string"
}
}
},
"toc-1-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"prefix": {
"type": "boolean"
}
}
},
"topic-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"title-numbering": {
"description": "Generate title numbering.",
"type": "boolean"
}
}
},
"ul-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"ul-1": {
"type": "string"
},
"ul-2": {
"type": "string"
},
"ul-3": {
"type": "string"
},
"ul-4": {
"type": "string"
}
}
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"default": "Theme template.",
"properties": {
"$schema": {
"type": "string"
},
"bookmark-style": {
"default": "COLLAPSED",
"description": "Expand state of PDF bookmarks.",
"enum": [
"COLLAPSED",
"EXPANDED"
],
"type": "string"
},
"chapter-layout": {
"default": "MINITOC",
"description": "Generate TOC for section.",
"enum": [
"MINITOC",
"BASIC"
],
"type": "string"
},
"extends": {
"description": "Extend another theme. Value is a URI to the theme to be extended.",
"type": "string"
},
"footer": {
"$ref": "#/$defs/header-type",
"description": "Page footer configuration."
},
"header": {
"$ref": "#/$defs/header-type",
"description": "Page header configuration."
},
"include-related-links": {
"default": "nofamily",
"description": "Specifies which link types are used to generate related links.",
"enum": [
"none",
"all",
"nofamily"
],
"type": "string"
},
"page": {
"$ref": "#/$defs/page-type",
"description": "Page configuration."
},
"page-number": {
"default": "page",
"description": "Generate page numbers with chapter number.",
"enum": [
"page",
"chapter-page"
],
"type": "string"
},
"style": {
"$ref": "#/$defs/style-type",
"description": "Style configuration."
},
"task-label": {
"default": false,
"description": "Generate labels for task sections.",
"type": "boolean"
},
"toc-maximum-level": {
"default": 4,
"description": "Maximum TOC depth.",
"type": "integer"
}
}
} | Apache-2.0 | en |
jelovirt/pdf-generator | cc627765d5f7f159eb19bf842d5b3160e0b27f7c | 2023-02-16T16:16:20 | src/main/resources/schema.json | 12 | 2024-05-28T04:36:36.069549Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"default": "Theme template.",
"definitions": {
"block-style-type": {
"properties": {
"background-color": {
"$ref": "#/definitions/colour-type"
},
"border-after-color": {
"$ref": "#/definitions/colour-type"
},
"border-after-style": {
"$ref": "#/definitions/border-style-type"
},
"border-after-width": {
"$ref": "#/definitions/length-type"
},
"border-before-color": {
"$ref": "#/definitions/colour-type"
},
"border-before-style": {
"$ref": "#/definitions/border-style-type"
},
"border-before-width": {
"$ref": "#/definitions/length-type"
},
"border-end-color": {
"$ref": "#/definitions/colour-type"
},
"border-end-style": {
"$ref": "#/definitions/border-style-type"
},
"border-end-width": {
"$ref": "#/definitions/length-type"
},
"border-start-color": {
"$ref": "#/definitions/colour-type"
},
"border-start-style": {
"$ref": "#/definitions/border-style-type"
},
"border-start-width": {
"$ref": "#/definitions/length-type"
},
"color": {
"$ref": "#/definitions/colour-type"
},
"end-indent": {
"$ref": "#/definitions/length-type"
},
"font-family": {
"type": "string"
},
"font-size": {
"$ref": "#/definitions/length-type"
},
"font-style": {
"type": "string"
},
"font-weight": {
"$ref": "#/definitions/font-weight-type"
},
"line-height": {
"$ref": "#/definitions/length-type"
},
"padding-after": {
"$ref": "#/definitions/length-type"
},
"padding-before": {
"$ref": "#/definitions/length-type"
},
"padding-end": {
"$ref": "#/definitions/length-type"
},
"padding-start": {
"$ref": "#/definitions/length-type"
},
"space-after": {
"$ref": "#/definitions/length-type"
},
"space-before": {
"$ref": "#/definitions/length-type"
},
"start-indent": {
"$ref": "#/definitions/length-type"
},
"text-align": {
"type": "string"
},
"text-decoration": {
"type": "string"
}
},
"type": "object"
},
"body-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {},
"type": "object"
},
"border-style-type": {
"enum": [
"none",
"hidden",
"dotted",
"dashed",
"solid",
"double",
"groove",
"ridge",
"inset",
"outset",
"inherit"
],
"type": "string"
},
"caption-type": {
"properties": {
"caption-number": {
"description": "Number captions.",
"enum": [
"chapter",
"document",
"none"
],
"type": "string"
},
"caption-position": {
"description": "Caption position.",
"enum": [
"after",
"before"
],
"type": "string"
}
}
},
"codeblock-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"caption-number": {
"description": "Number figures with chapter prefix or use whole document numbering.",
"enum": [
"chapter",
"document"
],
"type": "string"
},
"caption-position": {
"description": "Place figure caption before or after figure.",
"enum": [
"before",
"after"
],
"type": "string"
},
"line-numbering": {
"description": "Show line numbers.",
"type": "boolean"
},
"show-whitespace": {
"description": "Show whitespace characters.",
"type": "boolean"
}
},
"type": "object"
},
"colour-type": {
"pattern": "^(#[a-eA-E0-9]{6}|#[a-eA-E0-9]{3}|rgb\\(\\d+,\\d+,\\d+\\)|rgb\\(\\d+%,\\d+%,\\d+%\\)|transparent|aqua|black|blue|cyan|fuchsia|gray|green|lime|maroon|navy|olive|orange|pink|purple|red|silver|teal|white|yellow|inherit)$",
"type": "string"
},
"content-array-type": {
"allOf": [
{
"properties": {
"kind": {
"description": "Type of content block.",
"enum": [
"field"
],
"type": "string"
},
"value": {
"description": "Field name.",
"enum": [
"title",
"chapter",
"folio",
"folio-with-total"
],
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"kind": {
"description": "Type of content block.",
"enum": [
"text"
],
"type": "string"
},
"value": {
"description": "Text content of block.",
"type": "string"
}
},
"type": "object"
}
],
"description": "Header or footer contents. This is the parsed form of contents template.",
"examples": [
[
{
"kind": "field",
"value": "title"
},
{
"kind": "text",
"value": " \u2014 "
},
{
"kind": "field",
"value": "chapter"
}
]
],
"minItems": 0,
"type": "array"
},
"content-template-type": {
"description": "Header or footer contents template.",
"examples": [
"{title} \u2014 {chapter}"
],
"type": "string"
},
"content-type": {
"properties": {
"content": {
"anyOf": [
{
"$ref": "#/definitions/content-template-type"
},
{
"$ref": "#/definitions/content-array-type"
}
]
}
},
"type": "object"
},
"dl-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"dl-type": {
"description": "Definition list output style.",
"enum": [
"html",
"table",
"list"
],
"type": "string"
}
},
"type": "object"
},
"font-weight-type": {
"enum": [
"normal",
"bold",
"bolder",
"lighter",
"100",
"200",
"300",
"400",
"500",
"600",
"700",
"800",
"900",
"inherit"
],
"type": "string"
},
"header-type": {
"description": "Page header and footer configuration.",
"properties": {
"even": {
"allOf": [
{
"$ref": "#/definitions/odd-type"
}
],
"description": "Header or footer on recto pages."
},
"odd": {
"allOf": [
{
"$ref": "#/definitions/odd-type"
}
],
"description": "Header or footer on verso pages."
}
},
"type": "object"
},
"inline-style-type": {
"properties": {
"background-color": {
"$ref": "#/definitions/colour-type"
},
"color": {
"$ref": "#/definitions/colour-type"
},
"font-family": {
"type": "string"
},
"font-size": {
"$ref": "#/definitions/length-type"
},
"font-style": {
"enum": [
"normal",
"italic",
"oblique",
"backslant",
"inherit"
],
"type": "string"
},
"font-weight": {
"$ref": "#/definitions/font-weight-type"
},
"line-height": {
"$ref": "#/definitions/length-type"
},
"text-decoration": {
"type": "string"
}
},
"type": "object"
},
"label-type": {
"properties": {
"label": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/content-type"
}
]
}
}
},
"length-type": {
"pattern": "^-?\\d+(\\.\\d+)?(cm|mm|in|pt|pc|px|em)?$",
"type": "string"
},
"link-type": {
"allOf": [
{
"$ref": "#/definitions/inline-style-type"
}
],
"properties": {
"link-page-number": {
"description": "Generate page number to internal links.",
"type": "boolean"
}
},
"type": "object"
},
"note-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/label-type"
}
],
"type": "object"
},
"odd-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/content-type"
}
]
},
"ol-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"ol-1": {
"type": "string"
},
"ol-2": {
"type": "string"
},
"ol-3": {
"type": "string"
},
"ol-4": {
"type": "string"
},
"ol-after-1": {
"type": "string"
},
"ol-after-2": {
"type": "string"
},
"ol-after-3": {
"type": "string"
},
"ol-after-4": {
"type": "string"
}
},
"type": "object"
},
"page-size-type": {
"oneOf": [
{
"properties": {
"orientation": {
"default": "portrait",
"description": "Page orientation.",
"enum": [
"portrait",
"letter"
],
"type": "string"
},
"size": {
"default": "Letter",
"description": "Page size.",
"enum": [
"A3",
"A4",
"A5",
"Executive",
"JIS B5",
"Tabloid",
"Legal",
"Letter",
"PA4"
],
"type": "string"
}
},
"required": [
"size"
],
"type": "object"
},
{
"properties": {
"height": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "11in",
"description": "Page height."
},
"width": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "8.5in",
"description": "Page width."
}
},
"required": [
"height",
"width"
],
"type": "object"
}
],
"type": "object"
},
"page-type": {
"allOf": [
{
"$ref": "#/definitions/page-size-type"
},
{
"properties": {
"blank-pages": {
"default": false,
"description": "Mark blank pages with ",
"type": "boolean"
},
"body-column-count": {
"default": 1,
"description": "Column count on content pages.",
"type": "integer"
},
"bottom": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "20mm",
"description": "Page bottom margin."
},
"column-gap": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"description": "Column gap on multi column pages."
},
"force-count": {
"default": "auto",
"description": "Force chapter to end on even or odd pages.",
"enum": [
"auto",
"even",
"odd"
],
"type": "string"
},
"index-column-count": {
"default": 2,
"description": "Column count on index pages.",
"type": "integer"
},
"inside": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "20mm",
"description": "Page inside margin."
},
"mirror-margins": {
"default": false,
"description": "Duplex pages with recto and verso pages.",
"type": "boolean"
},
"outside": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "20mm",
"description": "Page outside margin."
},
"top": {
"allOf": [
{
"$ref": "#/definitions/length-type"
}
],
"default": "20mm",
"description": "Page top margin."
}
}
}
],
"description": "Page configuration.",
"examples": [
{
"bottom": "20mm",
"height": "297mm",
"inside": "30mm",
"outside": "20mm",
"top": "20mm",
"width": "210mm"
}
],
"type": "object"
},
"section-type": {
"allOf": [
{
"$ref": "#/definitions/body-type"
}
],
"properties": {
"title": {
"$ref": "#/definitions/body-type"
}
},
"type": "object"
},
"style-type": {
"allOf": [
{
"properties": {
"apiname": {
"$ref": "#/definitions/inline-style-type"
},
"b": {
"$ref": "#/definitions/inline-style-type"
},
"body": {
"$ref": "#/definitions/body-type"
},
"cmdname": {
"$ref": "#/definitions/inline-style-type"
},
"codeblock": {
"$ref": "#/definitions/codeblock-type"
},
"codeph": {
"$ref": "#/definitions/inline-style-type"
},
"cover": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"properties": {
"image-metadata": {
"default": null,
"description": "Name of metadata element to use as cover image.",
"type": "string"
},
"image-topic": {
"default": null,
"description": "Outputclass for cover topic.",
"type": "string"
},
"title": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/content-type"
}
]
}
}
}
]
},
"delim": {
"$ref": "#/definitions/inline-style-type"
},
"dl": {
"$ref": "#/definitions/dl-type"
},
"example": {
"$ref": "#/definitions/section-type"
},
"fig": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/caption-type"
}
],
"type": "object"
},
"filepath": {
"$ref": "#/definitions/inline-style-type"
},
"fragment": {
"$ref": "#/definitions/inline-style-type"
},
"fragref": {
"$ref": "#/definitions/inline-style-type"
},
"groupchoice": {
"$ref": "#/definitions/inline-style-type"
},
"groupcomp": {
"$ref": "#/definitions/inline-style-type"
},
"groupseq": {
"$ref": "#/definitions/inline-style-type"
},
"h1": {
"$ref": "#/definitions/topic-type"
},
"h2": {
"$ref": "#/definitions/topic-type"
},
"h3": {
"$ref": "#/definitions/topic-type"
},
"h4": {
"$ref": "#/definitions/topic-type"
},
"i": {
"$ref": "#/definitions/inline-style-type"
},
"keyword": {
"$ref": "#/definitions/inline-style-type"
},
"kwd": {
"$ref": "#/definitions/inline-style-type"
},
"line-through": {
"$ref": "#/definitions/inline-style-type"
},
"link": {
"allOf": [
{
"$ref": "#/definitions/link-type"
}
],
"properties": {
"external": {
"allOf": [
{
"$ref": "#/definitions/content-type"
}
]
}
}
},
"markupname": {
"$ref": "#/definitions/inline-style-type"
},
"menucascade": {
"$ref": "#/definitions/inline-style-type"
},
"note": {
"allOf": [
{
"$ref": "#/definitions/note-type"
},
{
"properties": {
"attention": {
"$ref": "#/definitions/note-type"
},
"caution": {
"$ref": "#/definitions/note-type"
},
"danger": {
"$ref": "#/definitions/note-type"
},
"fastpath": {
"$ref": "#/definitions/note-type"
},
"important": {
"$ref": "#/definitions/note-type"
},
"note": {
"$ref": "#/definitions/note-type"
},
"notice": {
"$ref": "#/definitions/note-type"
},
"other": {
"$ref": "#/definitions/note-type"
},
"remember": {
"$ref": "#/definitions/note-type"
},
"restriction": {
"$ref": "#/definitions/note-type"
},
"tip": {
"$ref": "#/definitions/note-type"
},
"trouble": {
"$ref": "#/definitions/note-type"
},
"warning": {
"$ref": "#/definitions/note-type"
}
},
"type": "object"
}
],
"type": "object"
},
"numcharref": {
"$ref": "#/definitions/inline-style-type"
},
"ol": {
"$ref": "#/definitions/ol-type"
},
"oper": {
"$ref": "#/definitions/inline-style-type"
},
"option": {
"$ref": "#/definitions/inline-style-type"
},
"overline": {
"$ref": "#/definitions/inline-style-type"
},
"parameterentity": {
"$ref": "#/definitions/inline-style-type"
},
"parmname": {
"$ref": "#/definitions/inline-style-type"
},
"pre": {
"$ref": "#/definitions/body-type"
},
"repsep": {
"$ref": "#/definitions/inline-style-type"
},
"screen": {
"$ref": "#/definitions/inline-style-type"
},
"section": {
"$ref": "#/definitions/section-type"
},
"sep": {
"$ref": "#/definitions/inline-style-type"
},
"shortcut": {
"$ref": "#/definitions/inline-style-type"
},
"shortdesc": {},
"sub": {
"$ref": "#/definitions/inline-style-type"
},
"sup": {
"$ref": "#/definitions/inline-style-type"
},
"synblk": {
"$ref": "#/definitions/inline-style-type"
},
"synnote": {
"$ref": "#/definitions/inline-style-type"
},
"synnoteref": {
"$ref": "#/definitions/inline-style-type"
},
"synph": {
"$ref": "#/definitions/inline-style-type"
},
"syntaxdiagram": {
"$ref": "#/definitions/inline-style-type"
},
"systemoutput": {
"$ref": "#/definitions/inline-style-type"
},
"table": {
"allOf": [
{
"$ref": "#/definitions/table-type"
}
],
"properties": {
"caption": {
"$ref": "#/definitions/block-style-type"
},
"header": {
"$ref": "#/definitions/block-style-type"
}
}
},
"term": {
"$ref": "#/definitions/inline-style-type"
},
"textentity": {
"$ref": "#/definitions/inline-style-type"
},
"tm": {
"$ref": "#/definitions/tm-type"
},
"toc-1": {
"$ref": "#/definitions/toc-1-type"
},
"toc-2": {
"$ref": "#/definitions/body-type"
},
"toc-3": {
"$ref": "#/definitions/body-type"
},
"toc-4": {
"$ref": "#/definitions/body-type"
},
"tt": {
"$ref": "#/definitions/inline-style-type"
},
"u": {
"$ref": "#/definitions/inline-style-type"
},
"uicontrol": {
"$ref": "#/definitions/inline-style-type"
},
"ul": {
"$ref": "#/definitions/ul-type"
},
"userinput": {
"$ref": "#/definitions/inline-style-type"
},
"var": {
"$ref": "#/definitions/inline-style-type"
},
"varname": {
"$ref": "#/definitions/inline-style-type"
},
"wintitle": {
"$ref": "#/definitions/inline-style-type"
},
"xmlatt": {
"$ref": "#/definitions/inline-style-type"
},
"xmlelement": {
"$ref": "#/definitions/inline-style-type"
},
"xmlnsname": {
"$ref": "#/definitions/inline-style-type"
},
"xmlpi": {
"$ref": "#/definitions/inline-style-type"
}
}
}
],
"type": "object"
},
"table-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
},
{
"$ref": "#/definitions/caption-type"
}
],
"properties": {
"table-continued": {
"default": false,
"description": "Generate 'Table continued' on page break within table.",
"type": "boolean"
}
},
"type": "object"
},
"tm-type": {
"allOf": [
{
"$ref": "#/definitions/inline-style-type"
}
],
"properties": {
"symbol-scope": {
"type": "string"
}
},
"type": "object"
},
"toc-1-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"prefix": {
"type": "boolean"
}
},
"type": "object"
},
"topic-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"title-numbering": {
"description": "Generate title numbering.",
"type": "boolean"
}
},
"type": "object"
},
"ul-type": {
"allOf": [
{
"$ref": "#/definitions/block-style-type"
}
],
"properties": {
"ul-1": {
"type": "string"
},
"ul-2": {
"type": "string"
},
"ul-3": {
"type": "string"
},
"ul-4": {
"type": "string"
}
},
"type": "object"
}
},
"properties": {
"$schema": {
"type": "string"
},
"bookmark-style": {
"default": "COLLAPSED",
"description": "Expand state of PDF bookmarks.",
"enum": [
"COLLAPSED",
"EXPANDED"
],
"type": "string"
},
"chapter-layout": {
"default": "MINITOC",
"description": "Generate TOC for section.",
"enum": [
"MINITOC",
"BASIC"
],
"type": "string"
},
"extends": {
"description": "Extend another theme. Value is a URI to the theme to be extended.",
"type": "string"
},
"footer": {
"allOf": [
{
"$ref": "#/definitions/header-type"
}
],
"description": "Page footer configuration."
},
"header": {
"allOf": [
{
"$ref": "#/definitions/header-type"
}
],
"description": "Page header configuration."
},
"include-related-links": {
"default": "nofamily",
"description": "Specifies which link types are used to generate related links.",
"enum": [
"none",
"all",
"nofamily"
],
"type": "string"
},
"page": {
"allOf": [
{
"$ref": "#/definitions/page-type"
}
],
"description": "Page configuration."
},
"page-number": {
"default": "page",
"description": "Generate page numbers with chapter number.",
"enum": [
"page",
"chapter-page"
],
"type": "string"
},
"style": {
"allOf": [
{
"$ref": "#/definitions/style-type"
}
],
"description": "Style configuration."
},
"task-label": {
"default": false,
"description": "Generate labels for task sections.",
"type": "boolean"
},
"toc-maximum-level": {
"default": 4,
"description": "Maximum TOC depth.",
"type": "integer"
}
},
"type": "object"
} | Apache-2.0 | en |
jelovirt/pdf-generator | d7edfc7a96c1c9834a2f22c3bff061895e6563d3 | 2023-10-23T02:28:11 | src/main/resources/schema.json | 12 | 2024-05-28T04:36:36.069549Z | {
"$defs": {
"block-style-type": {
"properties": {
"background-color": {
"$ref": "#/$defs/colour-type"
},
"border-after-color": {
"$ref": "#/$defs/colour-type"
},
"border-after-style": {
"$ref": "#/$defs/border-style-type"
},
"border-after-width": {
"$ref": "#/$defs/length-type"
},
"border-before-color": {
"$ref": "#/$defs/colour-type"
},
"border-before-style": {
"$ref": "#/$defs/border-style-type"
},
"border-before-width": {
"$ref": "#/$defs/length-type"
},
"border-end-color": {
"$ref": "#/$defs/colour-type"
},
"border-end-style": {
"$ref": "#/$defs/border-style-type"
},
"border-end-width": {
"$ref": "#/$defs/length-type"
},
"border-start-color": {
"$ref": "#/$defs/colour-type"
},
"border-start-style": {
"$ref": "#/$defs/border-style-type"
},
"border-start-width": {
"$ref": "#/$defs/length-type"
},
"color": {
"$ref": "#/$defs/colour-type"
},
"end-indent": {
"$ref": "#/$defs/length-type"
},
"font-family": {
"type": "string"
},
"font-size": {
"$ref": "#/$defs/length-type"
},
"font-style": {
"type": "string"
},
"font-weight": {
"$ref": "#/$defs/font-weight-type"
},
"line-height": {
"$ref": "#/$defs/length-type"
},
"padding-after": {
"$ref": "#/$defs/length-type"
},
"padding-before": {
"$ref": "#/$defs/length-type"
},
"padding-end": {
"$ref": "#/$defs/length-type"
},
"padding-start": {
"$ref": "#/$defs/length-type"
},
"space-after": {
"$ref": "#/$defs/length-type"
},
"space-before": {
"$ref": "#/$defs/length-type"
},
"start-indent": {
"$ref": "#/$defs/length-type"
},
"text-align": {
"type": "string"
},
"text-decoration": {
"type": "string"
}
}
},
"body-type": {
"$ref": "#/$defs/block-style-type",
"properties": {}
},
"border-style-type": {
"enum": [
"none",
"hidden",
"dotted",
"dashed",
"solid",
"double",
"groove",
"ridge",
"inset",
"outset",
"inherit"
],
"type": "string"
},
"caption-type": {
"properties": {
"caption-number": {
"description": "Number captions.",
"enum": [
"chapter",
"document",
"none"
],
"type": "string"
},
"caption-position": {
"description": "Caption position.",
"enum": [
"after",
"before"
],
"type": "string"
}
}
},
"codeblock-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"caption-number": {
"description": "Number figures with chapter prefix or use whole document numbering.",
"enum": [
"chapter",
"document"
],
"type": "string"
},
"caption-position": {
"description": "Place figure caption before or after figure.",
"enum": [
"before",
"after"
],
"type": "string"
},
"line-numbering": {
"description": "Show line numbers.",
"type": "boolean"
},
"show-whitespace": {
"description": "Show whitespace characters.",
"type": "boolean"
}
}
},
"colour-type": {
"pattern": "^(#[a-eA-E0-9]{6}|#[a-eA-E0-9]{3}|rgb\\(\\d+,\\d+,\\d+\\)|rgb\\(\\d+%,\\d+%,\\d+%\\)|transparent|aqua|black|blue|cyan|fuchsia|gray|green|lime|maroon|navy|olive|orange|pink|purple|red|silver|teal|white|yellow|inherit)$",
"type": "string"
},
"content-array-type": {
"allOf": [
{
"properties": {
"kind": {
"description": "Type of content block.",
"enum": [
"field"
],
"type": "string"
},
"value": {
"description": "Field name.",
"enum": [
"title",
"chapter",
"folio",
"folio-with-total"
],
"type": "string"
}
}
},
{
"properties": {
"kind": {
"description": "Type of content block.",
"enum": [
"text"
],
"type": "string"
},
"value": {
"description": "Text content of block.",
"type": "string"
}
}
}
],
"description": "Header or footer contents. This is the parsed form of contents template.",
"examples": [
[
{
"kind": "field",
"value": "title"
},
{
"kind": "text",
"value": " \u2014 "
},
{
"kind": "field",
"value": "chapter"
}
]
],
"minItems": 0,
"type": "array"
},
"content-template-type": {
"description": "Header or footer contents template.",
"examples": [
"{title} \u2014 {chapter}"
],
"type": "string"
},
"content-type": {
"properties": {
"content": {
"anyOf": [
{
"$ref": "#/$defs/content-template-type"
},
{
"$ref": "#/$defs/content-array-type"
}
]
}
}
},
"dl-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"dl-type": {
"description": "Definition list output style.",
"enum": [
"html",
"table",
"list"
],
"type": "string"
}
}
},
"font-weight-type": {
"enum": [
"normal",
"bold",
"bolder",
"lighter",
"100",
"200",
"300",
"400",
"500",
"600",
"700",
"800",
"900",
"inherit"
],
"type": "string"
},
"header-type": {
"description": "Page header and footer configuration.",
"properties": {
"even": {
"$ref": "#/$defs/odd-type",
"description": "Header or footer on recto pages."
},
"odd": {
"$ref": "#/$defs/odd-type",
"description": "Header or footer on verso pages."
}
}
},
"inline-style-type": {
"properties": {
"background-color": {
"$ref": "#/$defs/colour-type"
},
"color": {
"$ref": "#/$defs/colour-type"
},
"font-family": {
"type": "string"
},
"font-size": {
"$ref": "#/$defs/length-type"
},
"font-style": {
"enum": [
"normal",
"italic",
"oblique",
"backslant",
"inherit"
],
"type": "string"
},
"font-weight": {
"$ref": "#/$defs/font-weight-type"
},
"line-height": {
"$ref": "#/$defs/length-type"
},
"text-decoration": {
"type": "string"
}
}
},
"label-type": {
"properties": {
"label": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/content-type"
}
]
}
}
},
"length-type": {
"pattern": "^-?\\d+(\\.\\d+)?(cm|mm|in|pt|pc|px|em)?$",
"type": "string"
},
"link-type": {
"$ref": "#/$defs/inline-style-type",
"properties": {
"link-page-number": {
"description": "Generate page number to internal links.",
"type": "boolean"
}
}
},
"note-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/label-type"
}
]
},
"odd-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/content-type"
}
]
},
"ol-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"ol-1": {
"type": "string"
},
"ol-2": {
"type": "string"
},
"ol-3": {
"type": "string"
},
"ol-4": {
"type": "string"
},
"ol-after-1": {
"type": "string"
},
"ol-after-2": {
"type": "string"
},
"ol-after-3": {
"type": "string"
},
"ol-after-4": {
"type": "string"
}
}
},
"page-size-type": {
"oneOf": [
{
"properties": {
"orientation": {
"default": "portrait",
"description": "Page orientation.",
"enum": [
"portrait",
"letter"
],
"type": "string"
},
"size": {
"default": "Letter",
"description": "Page size.",
"enum": [
"A3",
"A4",
"A5",
"Executive",
"JIS B5",
"Tabloid",
"Legal",
"Letter",
"PA4"
],
"type": "string"
}
},
"required": [
"size"
]
},
{
"properties": {
"height": {
"$ref": "#/$defs/length-type",
"default": "11in",
"description": "Page height."
},
"width": {
"$ref": "#/$defs/length-type",
"default": "8.5in",
"description": "Page width."
}
},
"required": [
"height",
"width"
]
}
]
},
"page-type": {
"allOf": [
{
"$ref": "#/$defs/page-size-type"
},
{
"properties": {
"blank-pages": {
"default": false,
"description": "Mark blank pages with ",
"type": "boolean"
},
"body-column-count": {
"default": 1,
"description": "Column count on content pages.",
"type": "integer"
},
"bottom": {
"$ref": "#/$defs/length-type",
"default": "20mm",
"description": "Page bottom margin."
},
"column-gap": {
"$ref": "#/$defs/length-type",
"description": "Column gap on multi column pages."
},
"force-count": {
"default": "auto",
"description": "Force chapter to end on even or odd pages.",
"enum": [
"auto",
"even",
"odd"
],
"type": "string"
},
"index-column-count": {
"default": 2,
"description": "Column count on index pages.",
"type": "integer"
},
"inside": {
"$ref": "#/$defs/length-type",
"default": "20mm",
"description": "Page inside margin."
},
"mirror-margins": {
"default": false,
"description": "Duplex pages with recto and verso pages.",
"type": "boolean"
},
"outside": {
"$ref": "#/$defs/length-type",
"default": "20mm",
"description": "Page outside margin."
},
"top": {
"$ref": "#/$defs/length-type",
"default": "20mm",
"description": "Page top margin."
}
}
}
],
"description": "Page configuration.",
"examples": [
{
"bottom": "20mm",
"height": "297mm",
"inside": "30mm",
"outside": "20mm",
"top": "20mm",
"width": "210mm"
}
]
},
"section-type": {
"$ref": "#/$defs/body-type",
"properties": {
"title": {
"$ref": "#/$defs/body-type"
}
}
},
"style-type": {
"allOf": [
{
"properties": {
"apiname": {
"$ref": "#/$defs/inline-style-type"
},
"b": {
"$ref": "#/$defs/inline-style-type"
},
"body": {
"$ref": "#/$defs/body-type"
},
"cmdname": {
"$ref": "#/$defs/inline-style-type"
},
"codeblock": {
"$ref": "#/$defs/codeblock-type"
},
"codeph": {
"$ref": "#/$defs/inline-style-type"
},
"cover": {
"$ref": "#/$defs/block-style-type",
"properties": {
"image-metadata": {
"default": null,
"description": "Name of metadata element to use as cover image.",
"type": "string"
},
"image-topic": {
"default": null,
"description": "Outputclass for cover topic.",
"type": "string"
},
"title": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/content-type"
}
]
},
"titlealt": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/content-type"
}
]
}
}
},
"delim": {
"$ref": "#/$defs/inline-style-type"
},
"dl": {
"$ref": "#/$defs/dl-type"
},
"example": {
"$ref": "#/$defs/section-type"
},
"fig": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/caption-type"
}
]
},
"filepath": {
"$ref": "#/$defs/inline-style-type"
},
"fragment": {
"$ref": "#/$defs/inline-style-type"
},
"fragref": {
"$ref": "#/$defs/inline-style-type"
},
"groupchoice": {
"$ref": "#/$defs/inline-style-type"
},
"groupcomp": {
"$ref": "#/$defs/inline-style-type"
},
"groupseq": {
"$ref": "#/$defs/inline-style-type"
},
"h1": {
"$ref": "#/$defs/topic-type"
},
"h2": {
"$ref": "#/$defs/topic-type"
},
"h3": {
"$ref": "#/$defs/topic-type"
},
"h4": {
"$ref": "#/$defs/topic-type"
},
"i": {
"$ref": "#/$defs/inline-style-type"
},
"keyword": {
"$ref": "#/$defs/inline-style-type"
},
"kwd": {
"$ref": "#/$defs/inline-style-type"
},
"line-through": {
"$ref": "#/$defs/inline-style-type"
},
"link": {
"$ref": "#/$defs/link-type",
"properties": {
"external": {
"$ref": "#/$defs/content-type"
}
}
},
"markupname": {
"$ref": "#/$defs/inline-style-type"
},
"menucascade": {
"$ref": "#/$defs/inline-style-type"
},
"note": {
"$ref": "#/$defs/note-type",
"properties": {
"attention": {
"$ref": "#/$defs/note-type"
},
"caution": {
"$ref": "#/$defs/note-type"
},
"danger": {
"$ref": "#/$defs/note-type"
},
"fastpath": {
"$ref": "#/$defs/note-type"
},
"important": {
"$ref": "#/$defs/note-type"
},
"note": {
"$ref": "#/$defs/note-type"
},
"notice": {
"$ref": "#/$defs/note-type"
},
"other": {
"$ref": "#/$defs/note-type"
},
"remember": {
"$ref": "#/$defs/note-type"
},
"restriction": {
"$ref": "#/$defs/note-type"
},
"tip": {
"$ref": "#/$defs/note-type"
},
"trouble": {
"$ref": "#/$defs/note-type"
},
"warning": {
"$ref": "#/$defs/note-type"
}
}
},
"numcharref": {
"$ref": "#/$defs/inline-style-type"
},
"ol": {
"$ref": "#/$defs/ol-type"
},
"oper": {
"$ref": "#/$defs/inline-style-type"
},
"option": {
"$ref": "#/$defs/inline-style-type"
},
"overline": {
"$ref": "#/$defs/inline-style-type"
},
"parameterentity": {
"$ref": "#/$defs/inline-style-type"
},
"parmname": {
"$ref": "#/$defs/inline-style-type"
},
"pre": {
"$ref": "#/$defs/body-type"
},
"repsep": {
"$ref": "#/$defs/inline-style-type"
},
"screen": {
"$ref": "#/$defs/inline-style-type"
},
"section": {
"$ref": "#/$defs/section-type"
},
"sep": {
"$ref": "#/$defs/inline-style-type"
},
"shortcut": {
"$ref": "#/$defs/inline-style-type"
},
"shortdesc": {
"$ref": "#/$defs/block-style-type"
},
"sub": {
"$ref": "#/$defs/inline-style-type"
},
"sup": {
"$ref": "#/$defs/inline-style-type"
},
"synblk": {
"$ref": "#/$defs/inline-style-type"
},
"synnote": {
"$ref": "#/$defs/inline-style-type"
},
"synnoteref": {
"$ref": "#/$defs/inline-style-type"
},
"synph": {
"$ref": "#/$defs/inline-style-type"
},
"syntaxdiagram": {
"$ref": "#/$defs/inline-style-type"
},
"systemoutput": {
"$ref": "#/$defs/inline-style-type"
},
"table": {
"$ref": "#/$defs/table-type",
"properties": {
"caption": {
"$ref": "#/$defs/block-style-type"
},
"header": {
"$ref": "#/$defs/block-style-type"
}
}
},
"term": {
"$ref": "#/$defs/inline-style-type"
},
"textentity": {
"$ref": "#/$defs/inline-style-type"
},
"tm": {
"$ref": "#/$defs/tm-type"
},
"toc-1": {
"$ref": "#/$defs/toc-1-type"
},
"toc-2": {
"$ref": "#/$defs/body-type"
},
"toc-3": {
"$ref": "#/$defs/body-type"
},
"toc-4": {
"$ref": "#/$defs/body-type"
},
"tt": {
"$ref": "#/$defs/inline-style-type"
},
"u": {
"$ref": "#/$defs/inline-style-type"
},
"uicontrol": {
"$ref": "#/$defs/inline-style-type"
},
"ul": {
"$ref": "#/$defs/ul-type"
},
"userinput": {
"$ref": "#/$defs/inline-style-type"
},
"var": {
"$ref": "#/$defs/inline-style-type"
},
"varname": {
"$ref": "#/$defs/inline-style-type"
},
"wintitle": {
"$ref": "#/$defs/inline-style-type"
},
"xmlatt": {
"$ref": "#/$defs/inline-style-type"
},
"xmlelement": {
"$ref": "#/$defs/inline-style-type"
},
"xmlnsname": {
"$ref": "#/$defs/inline-style-type"
},
"xmlpi": {
"$ref": "#/$defs/inline-style-type"
}
}
}
]
},
"table-type": {
"allOf": [
{
"$ref": "#/$defs/block-style-type"
},
{
"$ref": "#/$defs/caption-type"
}
],
"properties": {
"table-continued": {
"default": false,
"description": "Generate 'Table continued' on page break within table.",
"type": "boolean"
}
}
},
"tm-type": {
"$ref": "#/$defs/inline-style-type",
"properties": {
"symbol-scope": {
"type": "string"
}
}
},
"toc-1-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"prefix": {
"type": "boolean"
}
}
},
"topic-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"title-numbering": {
"description": "Generate title numbering.",
"type": "boolean"
}
}
},
"ul-type": {
"$ref": "#/$defs/block-style-type",
"properties": {
"ul-1": {
"type": "string"
},
"ul-2": {
"type": "string"
},
"ul-3": {
"type": "string"
},
"ul-4": {
"type": "string"
}
}
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"default": "Theme template.",
"properties": {
"$schema": {
"type": "string"
},
"bookmark-style": {
"default": "COLLAPSED",
"description": "Expand state of PDF bookmarks.",
"enum": [
"COLLAPSED",
"EXPANDED"
],
"type": "string"
},
"chapter-layout": {
"default": "MINITOC",
"description": "Generate TOC for section.",
"enum": [
"MINITOC",
"BASIC"
],
"type": "string"
},
"extends": {
"description": "Extend another theme. Value is a URI to the theme to be extended.",
"type": "string"
},
"footer": {
"$ref": "#/$defs/header-type",
"description": "Page footer configuration."
},
"header": {
"$ref": "#/$defs/header-type",
"description": "Page header configuration."
},
"include-related-links": {
"default": "nofamily",
"description": "Specifies which link types are used to generate related links.",
"enum": [
"none",
"all",
"nofamily"
],
"type": "string"
},
"page": {
"$ref": "#/$defs/page-type",
"description": "Page configuration."
},
"page-number": {
"default": "page",
"description": "Generate page numbers with chapter number.",
"enum": [
"page",
"chapter-page"
],
"type": "string"
},
"style": {
"$ref": "#/$defs/style-type",
"description": "Style configuration."
},
"task-label": {
"default": false,
"description": "Generate labels for task sections.",
"type": "boolean"
},
"toc-maximum-level": {
"default": 4,
"description": "Maximum TOC depth.",
"type": "integer"
}
}
} | Apache-2.0 | en |
canonical/charm-relation-interfaces | 803c3da65e5f859c3c137fb19502c507c6fc27e1 | 2023-02-21T10:41:19 | interfaces/opensearch_client/v0/schemas/requirer.json | 16 | 2024-05-27T04:41:24.782662Z | {
"$id": "https://canonical.github.io/charm-relation-interfaces/interfaces/opensearch_client/schemas/requirer.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": true,
"default": {},
"description": "The `opensearch_client` root schema comprises the entire requirer databag for this interface.",
"examples": [
{
"database": "myapp",
"extra-user-roles": "default,admin"
}
],
"properties": {
"database": {
"default": "",
"description": "The database name requested by the requirer",
"examples": [
"myapp"
],
"title": "Index Name",
"type": "string"
},
"extra-user-roles": {
"default": "default",
"description": "Any extra user roles requested by the requirer",
"examples": [
"default,admin"
],
"title": "Extra-user-roles",
"type": "string"
}
},
"required": [
"database"
],
"title": "`opensearch_client` requirer schema",
"type": "object"
} | Apache-2.0 | en |
canonical/charm-relation-interfaces | 642e59b6be73b9ac88688656e5208dc082eb264e | 2023-01-03T18:57:12 | interfaces/database_backup/v0/schemas/requirer.json | 16 | 2024-05-27T04:41:24.782662Z | {
"$id": "https://canonical.github.io/charm-relation-interfaces/interfaces/database_backup_manager/schemas/requirer.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": true,
"default": {},
"description": "The `database_backup_manager` root schema comprises the entire requirer databag for this interface.",
"examples": [
{
"jobs": [
{
"job-config": {
"compression": true
},
"job-id": "job-01693ed2-644f-11ed-81ce-0242ac120001",
"job-type": "backup",
"storage-config": {
"access-key": "access-key",
"bucket": "my-bucket",
"secret-key": "secret-key"
},
"storage-interface": "s3"
},
{
"artefact-path": "/path/to/retrieve/backups/",
"job-config": {
"compression": false
},
"job-id": "job-ad989f5a-6453-11ed-81ce-0242ac120003",
"job-type": "restore",
"storage-config": {
"access-key": "access-key",
"bucket": "my-bucket",
"secret-key": "secret-key"
},
"storage-interface": "s3"
}
]
}
],
"properties": {
"jobs": {
"items": {
"additionalProperties": true,
"properties": {
"artefact-path": {
"description": "The artifact path for the job. This is where backup files and logs are stored",
"examples": [
"/path/to/artefacts/"
],
"title": "Artefact path",
"type": "string"
},
"job-config": {
"additionalProperties": false,
"description": "The job configuration",
"properties": {
"compression": {
"description": "Whether the backups are compressed",
"title": "Compression",
"type": "boolean"
}
},
"required": [
"compression"
],
"title": "Job config",
"type": "object"
},
"job-id": {
"description": "A unique id for the job. Is the same value as the one provided by the Requirer.",
"examples": [
"job-01693ed2-644f-11ed-81ce-0242ac120001"
],
"title": "Job ID",
"type": "string"
},
"job-type": {
"default": "backup",
"description": "The job type. Is the same value as the one provided by the Requirer.",
"enum": [
"backup",
"restore"
],
"title": "Job type",
"type": "string"
},
"storage-config": {
"oneOf": [
{
"$ref": "https://canonical.github.io/charm-relation-interfaces/interfaces/s3/schemas/provider.json"
}
]
},
"storage-interface": {
"default": "s3",
"description": "The storage interface to use for storing or retrieving files",
"enum": [
"s3"
],
"title": "Storage interface",
"type": "string"
}
},
"required": [
"job-id",
"job-type",
"job-config",
"storage-interface",
"storage-config"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"jobs"
],
"title": "`database_backup_manager` requirer schema",
"type": "object"
} | Apache-2.0 | en |
canonical/charm-relation-interfaces | 1dbfc367bbfeb7d9ff63d5bb364fe411b5cb1ae7 | 2023-01-03T18:57:12 | interfaces/database_backup/v0/schemas/requirer.json | 16 | 2024-05-27T04:41:24.782662Z | {
"$id": "https://canonical.github.io/charm-relation-interfaces/interfaces/database_backup/schemas/requirer.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": true,
"default": {},
"description": "The `database_backup` root schema comprises the entire requirer databag for this interface.",
"examples": [
{
"jobs": [
{
"job-config": {
"compression": true
},
"job-id": "job-01693ed2-644f-11ed-81ce-0242ac120001",
"job-type": "backup",
"storage-config": {
"access-key": "access-key",
"bucket": "my-bucket",
"secret-key": "secret-key"
},
"storage-interface": "s3"
},
{
"artefact-path": "/path/to/retrieve/backups/",
"job-config": {
"compression": false
},
"job-id": "job-ad989f5a-6453-11ed-81ce-0242ac120003",
"job-type": "restore",
"storage-config": {
"access-key": "access-key",
"bucket": "my-bucket",
"secret-key": "secret-key"
},
"storage-interface": "s3"
}
]
}
],
"properties": {
"jobs": {
"items": {
"additionalProperties": true,
"properties": {
"artefact-path": {
"description": "The artifact path for the job. This is where backup files and logs are stored",
"examples": [
"/path/to/artefacts/"
],
"title": "Artefact path",
"type": "string"
},
"job-config": {
"additionalProperties": false,
"description": "The job configuration",
"properties": {
"compression": {
"description": "Whether the backups are compressed",
"title": "Compression",
"type": "boolean"
}
},
"required": [
"compression"
],
"title": "Job config",
"type": "object"
},
"job-id": {
"description": "A unique id for the job. Is the same value as the one provided by the Requirer.",
"examples": [
"job-01693ed2-644f-11ed-81ce-0242ac120001"
],
"title": "Job ID",
"type": "string"
},
"job-type": {
"default": "backup",
"description": "The job type. Is the same value as the one provided by the Requirer.",
"enum": [
"backup",
"restore"
],
"title": "Job type",
"type": "string"
},
"storage-config": {
"oneOf": [
{
"$ref": "https://canonical.github.io/charm-relation-interfaces/interfaces/s3/schemas/provider.json"
}
]
},
"storage-interface": {
"default": "s3",
"description": "The storage interface to use for storing or retrieving files",
"enum": [
"s3"
],
"title": "Storage interface",
"type": "string"
}
},
"required": [
"job-id",
"job-type",
"job-config",
"storage-interface",
"storage-config"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"jobs"
],
"title": "`database_backup` requirer schema",
"type": "object"
} | Apache-2.0 | en |
canonical/charm-relation-interfaces | 1dbfc367bbfeb7d9ff63d5bb364fe411b5cb1ae7 | 2023-01-03T18:57:12 | interfaces/database_backup/v0/schemas/provider.json | 16 | 2024-05-27T04:41:24.782662Z | {
"$id": "https://canonical.github.io/charm-relation-interfaces/interfaces/database_backup/schemas/provider.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": true,
"default": {},
"description": "The `database_backup` root schema comprises the entire provider databag for this interface.",
"examples": [
{
"jobs": [
{
"artefact-path": "/path/to/backup/",
"job-config": {
"compression": true
},
"job-id": "job-01693ed2-644f-11ed-81ce-0242ac120001",
"job-type": "backup",
"status": "success",
"storage-config": {
"access-key": "access-key",
"bucket": "my-bucket",
"secret-key": "secret-key"
},
"storage-interface": "s3"
},
{
"job-config": {
"compression": true
},
"job-id": "job-d0e6d45c-6450-11ed-81ce-0242ac120002",
"job-type": "restore",
"message": "MySQL charm in blocked state",
"status": "error",
"storage-config": {
"access-key": "access-key",
"bucket": "my-bucket",
"secret-key": "secret-key"
},
"storage-interface": "s3"
}
]
}
],
"properties": {
"jobs": {
"items": {
"additionalProperties": true,
"properties": {
"artefact-path": {
"description": "The artefact path for the job. This is where backup files and logs are stored",
"examples": [
"/path/to/artefacts/"
],
"title": "Artefact path",
"type": "string"
},
"job-config": {
"additionalProperties": false,
"description": "The job configuration",
"properties": {
"compression": {
"description": "Whether the backups are compressed",
"title": "Compression",
"type": "boolean"
}
},
"required": [
"compression"
],
"title": "Job config",
"type": "object"
},
"job-id": {
"description": "A unique id for the job. Is the same value as the one provided by the Requirer.",
"examples": [
"job-01693ed2-644f-11ed-81ce-0242ac120002"
],
"title": "Job ID",
"type": "string"
},
"job-type": {
"default": "backup",
"description": "The job type. Is the same value as the one provided by the Requirer.",
"enum": [
"backup",
"restore"
],
"title": "Job type",
"type": "string"
},
"message": {
"description": "A message describing the status of the job (e.g. an error message)",
"title": "Job message",
"type": "string"
},
"status": {
"description": "The status of the job once it has completed",
"enum": [
"running",
"success",
"error"
],
"title": "Job status",
"type": "string"
},
"storage-config": {
"oneOf": [
{
"$ref": "https://canonical.github.io/charm-relation-interfaces/interfaces/s3/schemas/provider.json"
}
]
},
"storage-interface": {
"default": "s3",
"description": "The storage interface to use for storing or retrieving files",
"enum": [
"s3"
],
"title": "Storage interface",
"type": "string"
}
},
"required": [
"job-id",
"job-type",
"status",
"storage-interface",
"storage-config"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"jobs"
],
"title": "`database_backup` provider schema",
"type": "object"
} | Apache-2.0 | en |
canonical/charm-relation-interfaces | eb93ff0df23b3373b5d606920637935cf39e43d3 | 2022-08-10T10:33:45 | interfaces/mongodb_client/v0/schemas/requirer.json | 16 | 2024-05-27T04:41:24.782662Z | {
"$id": "https://canonical.github.io/charm-relation-interfaces/interfaces/mongodb_client/schemas/requirer.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": true,
"default": {},
"description": "The `mongodb_client` root schema comprises the entire requirer databag for this interface.",
"examples": [
{
"database": "myapp",
"extra-user-roles": "default,admin"
}
],
"properties": {
"database": {
"default": "",
"description": "The database name requested by the requirer",
"examples": [
"myapp"
],
"title": "Database Name",
"type": "string"
},
"extra-user-roles": {
"default": "default",
"description": "Any extra user roles requested by the requirer",
"examples": [
"default,admin"
],
"title": "Extra-user-roles",
"type": "string"
}
},
"required": [
"database"
],
"title": "`mongodb_client` requirer schema",
"type": "object"
} | Apache-2.0 | en |
canonical/charm-relation-interfaces | 1ac301c532683c6cbf73fa7ba66698a9e5613b2a | 2022-11-08T08:47:31 | interfaces/s3/v0/schemas/requirer.json | 16 | 2024-05-27T04:41:24.782662Z | {
"$id": "https://canonical.github.io/charm-relation-interfaces/interfaces/s3/schemas/requirer.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": true,
"default": {},
"description": "The `s3` root schema comprises the entire provider databag for this interface.",
"examples": [
{
"bucket": "myapp"
}
],
"properties": {
"bucket": {
"default": "",
"description": "The bucket name requested by the requirer",
"examples": [
"relation-17"
],
"title": "Bucket Name",
"type": "string"
}
},
"required": [
"bucket"
],
"title": "`s3` provider schema",
"type": "object"
} | Apache-2.0 | en |
canonical/charm-relation-interfaces | f12424c9ebf4b85a2111cabe9ac31c6ed670fe30 | 2023-10-24T14:04:57 | interfaces/postgresql_client/v0/schemas/requirer.json | 16 | 2024-05-27T04:41:24.782662Z | {
"$id": "https://canonical.github.io/charm-relation-interfaces/interfaces/postgresql_client/schemas/requirer.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": true,
"default": {},
"description": "The `postgresql_client` root schema comprises the entire requirer databag for this interface.",
"examples": [
{
"database": "myapp",
"extra-user-roles": "default,admin"
}
],
"properties": {
"database": {
"default": "",
"description": "The database name requested by the requirer",
"examples": [
"myapp"
],
"title": "Database Name",
"type": "string"
},
"extra-user-roles": {
"default": "default",
"description": "Any extra user roles requested by the requirer",
"examples": [
"default,admin"
],
"title": "Extra-user-roles",
"type": "string"
},
"requested-secrets": {
"description": "Any provider field which should be transfered as Juju Secret",
"items": {
"type": "string"
},
"title": "Requested Secrets",
"type": "array"
}
},
"required": [
"database"
],
"title": "`postgresql_client` requirer schema",
"type": "object"
} | Apache-2.0 | en |
canonical/charm-relation-interfaces | 1ac301c532683c6cbf73fa7ba66698a9e5613b2a | 2022-11-08T08:47:31 | interfaces/s3/v0/schemas/provider.json | 16 | 2024-05-27T04:41:24.782662Z | {
"$id": "https://canonical.github.io/charm-relation-interfaces/interfaces/s3/schemas/provider.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": true,
"default": {},
"description": "The `s3` root schema comprises the entire provider databag for this interface.",
"examples": [
{
"access-key": "RANDOM",
"attributes": [
"Cache-Control=max-age=90000,min-fresh=9000",
"X-Amz-Server-Side-Encryption-Customer-Key=CuStoMerKey="
],
"bucket": "minio",
"endpoint": "https://minio-endpoint/",
"path": "relation-68",
"region": "us-east-1",
"s3-api-version": 4,
"s3-uri-style": "path",
"secret-key": "RANDOM",
"storage-class": "glacier",
"tls-ca-chain": [
"base64-encoded-ca-chain=="
]
}
],
"properties": {
"access-key": {
"default": "",
"description": "Access Key ID (account) for connecting to the object storage.",
"examples": [
"username"
],
"title": "Access Key ID",
"type": "string"
},
"attributes": {
"description": "The custom metadata (HTTP headers).",
"examples": [
[
"Cache-Control=max-age=90000,min-fresh=9000",
"X-Amz-Server-Side-Encryption-Customer-Key=CuStoMerKey="
]
],
"items": {
"type": "string"
},
"title": "Custom metadata",
"type": "array"
},
"bucket": {
"default": "",
"description": "The bucket/container name delivered by the provider.",
"examples": [
"minio"
],
"title": "Bucket name",
"type": "string"
},
"endpoint": {
"default": "",
"description": "The endpoint used to connect to the object storage.",
"examples": [
"https://minio-endpoint/"
],
"title": "Endpoint URL",
"type": "string"
},
"path": {
"default": "",
"description": "The path inside the bucket/container to store objects.",
"examples": [
"relation-24"
],
"title": "Path",
"type": "string"
},
"region": {
"default": "",
"description": "The region used to connect to the object storage.",
"examples": [
"us-east-1"
],
"title": "Region",
"type": "string"
},
"s3-api-version": {
"default": "",
"description": "S3 protocol specific API signature.",
"enum": [
2,
4
],
"examples": [
2,
4
],
"title": "S3 API signature",
"type": "integer"
},
"s3-uri-style": {
"default": "",
"description": "The S3 protocol specific bucket path lookup type.",
"examples": [
"path",
"host"
],
"title": "S3 URI Style",
"type": "string"
},
"secret-key": {
"default": "",
"description": "Access Key Secret ID (password) for connecting to the object storage.",
"examples": [
"alphanum-32byte-random"
],
"title": "Access Secret Key ID",
"type": "string"
},
"storage-class": {
"default": "",
"description": "Storage Class for objects uploaded to the object storage.",
"examples": [
"glacier"
],
"title": "Storage Class",
"type": "string"
},
"tls-ca-chain": {
"description": "The complete CA chain, which can be used for HTTPS validation.",
"examples": [
[
"base64-encoded-ca-chain=="
]
],
"items": {
"type": "string"
},
"title": "TLS CA Chain",
"type": "array"
}
},
"required": [
"bucket",
"access-key",
"secret-key"
],
"title": "`s3` provider schema",
"type": "object"
} | Apache-2.0 | en |
canonical/charm-relation-interfaces | ba63b567938406989adac89d900acbef6c22cee0 | 2023-09-19T08:30:05 | interfaces/opensearch_client/v0/schemas/requirer.json | 16 | 2024-05-27T04:41:24.782662Z | {
"$id": "https://canonical.github.io/charm-relation-interfaces/interfaces/opensearch_client/schemas/requirer.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": true,
"default": {},
"description": "The `opensearch_client` root schema comprises the entire requirer databag for this interface.",
"examples": [
{
"extra-user-roles": "default,admin",
"index": "myindex"
}
],
"properties": {
"extra-user-roles": {
"default": "default",
"description": "Any extra user roles requested by the requirer",
"examples": [
"default,admin"
],
"title": "Extra-user-roles",
"type": "string"
},
"index": {
"default": "",
"description": "The index name requested by the requirer",
"examples": [
"myapp"
],
"title": "Index Name",
"type": "string"
},
"requested-secrets": {
"description": "Any provider field which should be transfered as Juju Secret",
"items": {
"type": "string"
},
"title": "Requested Secrets",
"type": "array"
}
},
"required": [
"index"
],
"title": "`opensearch_client` requirer schema",
"type": "object"
} | Apache-2.0 | en |
canonical/charm-relation-interfaces | eb93ff0df23b3373b5d606920637935cf39e43d3 | 2022-08-10T10:33:45 | interfaces/mysql_client/v0/schemas/requirer.json | 16 | 2024-05-27T04:41:24.782662Z | {
"$id": "https://canonical.github.io/charm-relation-interfaces/interfaces/mysql_client/schemas/requirer.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": true,
"default": {},
"description": "The `mysql_client` root schema comprises the entire requirer databag for this interface.",
"examples": [
{
"database": "myapp",
"extra-user-roles": "default,admin"
}
],
"properties": {
"database": {
"default": "",
"description": "The database name requested by the requirer",
"examples": [
"myapp"
],
"title": "Database Name",
"type": "string"
},
"extra-user-roles": {
"default": "default",
"description": "Any extra user roles requested by the requirer",
"examples": [
"default,admin"
],
"title": "Extra-user-roles",
"type": "string"
}
},
"required": [
"database"
],
"title": "`mysql_client` requirer schema",
"type": "object"
} | Apache-2.0 | en |
canonical/charm-relation-interfaces | ed718c97105077c4a682b8a3d6ac36368cc15223 | 2023-02-21T10:41:19 | interfaces/opensearch_client/v0/schemas/requirer.json | 16 | 2024-05-27T04:41:24.782662Z | {
"$id": "https://canonical.github.io/charm-relation-interfaces/interfaces/opensearch_client/schemas/requirer.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": true,
"default": {},
"description": "The `opensearch_client` root schema comprises the entire requirer databag for this interface.",
"examples": [
{
"extra-user-roles": "default,admin",
"index": "myindex"
}
],
"properties": {
"extra-user-roles": {
"default": "default",
"description": "Any extra user roles requested by the requirer",
"examples": [
"default,admin"
],
"title": "Extra-user-roles",
"type": "string"
},
"index": {
"default": "",
"description": "The index name requested by the requirer",
"examples": [
"myapp"
],
"title": "Index Name",
"type": "string"
}
},
"required": [
"index"
],
"title": "`opensearch_client` requirer schema",
"type": "object"
} | Apache-2.0 | en |
canonical/charm-relation-interfaces | 8fe76a5675ec7889ba52111586409f510f6847c6 | 2024-02-12T11:37:41 | interfaces/postgresql_client/v0/schemas/requirer.json | 16 | 2024-05-27T04:41:24.782662Z | {
"$id": "https://canonical.github.io/charm-relation-interfaces/interfaces/postgresql_client/schemas/requirer.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": true,
"default": {},
"description": "The `postgresql_client` root schema comprises the entire requirer databag for this interface.",
"examples": [
{
"database": "myapp",
"extra-user-roles": "default,admin"
}
],
"properties": {
"database": {
"default": "",
"description": "The database name requested by the requirer",
"examples": [
"myapp"
],
"title": "Database Name",
"type": "string"
},
"external-node-connectivity": {
"default": "true",
"description": "Provide external connectivity, if subordinate router",
"examples": [
"true"
],
"title": "External node connectivity",
"type": "string"
},
"extra-user-roles": {
"default": "default",
"description": "Any extra user roles requested by the requirer",
"examples": [
"default,admin"
],
"title": "Extra-user-roles",
"type": "string"
},
"requested-secrets": {
"description": "Any provider field which should be transfered as Juju Secret",
"items": {
"type": "string"
},
"title": "Requested Secrets",
"type": "array"
}
},
"required": [
"database"
],
"title": "`postgresql_client` requirer schema",
"type": "object"
} | Apache-2.0 | en |
canonical/charm-relation-interfaces | 5c013a09e107787f312b046cefe00ee499eba719 | 2023-10-24T14:04:40 | interfaces/mysql_client/v0/schemas/requirer.json | 16 | 2024-05-27T04:41:24.782662Z | {
"$id": "https://canonical.github.io/charm-relation-interfaces/interfaces/mysql_client/schemas/requirer.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": true,
"default": {},
"description": "The `mysql_client` root schema comprises the entire requirer databag for this interface.",
"examples": [
{
"database": "myapp",
"extra-user-roles": "default,admin"
}
],
"properties": {
"database": {
"default": "",
"description": "The database name requested by the requirer",
"examples": [
"myapp"
],
"title": "Database Name",
"type": "string"
},
"extra-user-roles": {
"default": "default",
"description": "Any extra user roles requested by the requirer",
"examples": [
"default,admin"
],
"title": "Extra-user-roles",
"type": "string"
},
"requested-secrets": {
"description": "Any provider field which should be transfered as Juju Secret",
"items": {
"type": "string"
},
"title": "Requested Secrets",
"type": "array"
}
},
"required": [
"database"
],
"title": "`mysql_client` requirer schema",
"type": "object"
} | Apache-2.0 | en |
canonical/charm-relation-interfaces | ccbe81dbf32d755d30532a89f0c53ff05498c943 | 2023-10-24T14:04:13 | interfaces/mongodb_client/v0/schemas/requirer.json | 16 | 2024-05-27T04:41:24.782662Z | {
"$id": "https://canonical.github.io/charm-relation-interfaces/interfaces/mongodb_client/schemas/requirer.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": true,
"default": {},
"description": "The `mongodb_client` root schema comprises the entire requirer databag for this interface.",
"examples": [
{
"database": "myapp",
"extra-user-roles": "default,admin"
}
],
"properties": {
"database": {
"default": "",
"description": "The database name requested by the requirer",
"examples": [
"myapp"
],
"title": "Database Name",
"type": "string"
},
"extra-user-roles": {
"default": "default",
"description": "Any extra user roles requested by the requirer",
"examples": [
"default,admin"
],
"title": "Extra-user-roles",
"type": "string"
},
"requested-secrets": {
"description": "Any provider field which should be transfered as Juju Secret",
"items": {
"type": "string"
},
"title": "Requested Secrets",
"type": "array"
}
},
"required": [
"database"
],
"title": "`mongodb_client` requirer schema",
"type": "object"
} | Apache-2.0 | en |
canonical/charm-relation-interfaces | eb93ff0df23b3373b5d606920637935cf39e43d3 | 2022-08-10T10:33:45 | interfaces/postgresql_client/v0/schemas/requirer.json | 16 | 2024-05-27T04:41:24.782662Z | {
"$id": "https://canonical.github.io/charm-relation-interfaces/interfaces/postgresql_client/schemas/requirer.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": true,
"default": {},
"description": "The `postgresql_client` root schema comprises the entire requirer databag for this interface.",
"examples": [
{
"database": "myapp",
"extra-user-roles": "default,admin"
}
],
"properties": {
"database": {
"default": "",
"description": "The database name requested by the requirer",
"examples": [
"myapp"
],
"title": "Database Name",
"type": "string"
},
"extra-user-roles": {
"default": "default",
"description": "Any extra user roles requested by the requirer",
"examples": [
"default,admin"
],
"title": "Extra-user-roles",
"type": "string"
}
},
"required": [
"database"
],
"title": "`postgresql_client` requirer schema",
"type": "object"
} | Apache-2.0 | en |
canonical/charm-relation-interfaces | 642e59b6be73b9ac88688656e5208dc082eb264e | 2023-01-03T18:57:12 | interfaces/database_backup/v0/schemas/provider.json | 16 | 2024-05-27T04:41:24.782662Z | {
"$id": "https://canonical.github.io/charm-relation-interfaces/interfaces/database_backup_manager/schemas/provider.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": true,
"default": {},
"description": "The `database_backup_manager` root schema comprises the entire provider databag for this interface.",
"examples": [
{
"jobs": [
{
"artefact-path": "/path/to/backup/",
"job-config": {
"compression": true
},
"job-id": "job-01693ed2-644f-11ed-81ce-0242ac120001",
"job-type": "backup",
"status": "success",
"storage-config": {
"access-key": "access-key",
"bucket": "my-bucket",
"secret-key": "secret-key"
},
"storage-interface": "s3"
},
{
"job-config": {
"compression": true
},
"job-id": "job-d0e6d45c-6450-11ed-81ce-0242ac120002",
"job-type": "restore",
"message": "MySQL charm in blocked state",
"status": "error",
"storage-config": {
"access-key": "access-key",
"bucket": "my-bucket",
"secret-key": "secret-key"
},
"storage-interface": "s3"
}
]
}
],
"properties": {
"jobs": {
"items": {
"additionalProperties": true,
"properties": {
"artefact-path": {
"description": "The artefact path for the job. This is where backup files and logs are stored",
"examples": [
"/path/to/artefacts/"
],
"title": "Artefact path",
"type": "string"
},
"job-config": {
"additionalProperties": false,
"description": "The job configuration",
"properties": {
"compression": {
"description": "Whether the backups are compressed",
"title": "Compression",
"type": "boolean"
}
},
"required": [
"compression"
],
"title": "Job config",
"type": "object"
},
"job-id": {
"description": "A unique id for the job. Is the same value as the one provided by the Requirer.",
"examples": [
"job-01693ed2-644f-11ed-81ce-0242ac120002"
],
"title": "Job ID",
"type": "string"
},
"job-type": {
"default": "backup",
"description": "The job type. Is the same value as the one provided by the Requirer.",
"enum": [
"backup",
"restore"
],
"title": "Job type",
"type": "string"
},
"message": {
"description": "A message describing the status of the job (e.g. an error message)",
"title": "Job message",
"type": "string"
},
"status": {
"description": "The status of the job once it has completed",
"enum": [
"running",
"success",
"error"
],
"title": "Job status",
"type": "string"
},
"storage-config": {
"oneOf": [
{
"$ref": "https://canonical.github.io/charm-relation-interfaces/interfaces/s3/schemas/provider.json"
}
]
},
"storage-interface": {
"default": "s3",
"description": "The storage interface to use for storing or retrieving files",
"enum": [
"s3"
],
"title": "Storage interface",
"type": "string"
}
},
"required": [
"job-id",
"job-type",
"status",
"storage-interface",
"storage-config"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"jobs"
],
"title": "`database_backup_manager` provider schema",
"type": "object"
} | Apache-2.0 | en |
novuhq/novu | f64be4124505015291448d826481aabaea9a177f | 2024-05-06T11:34:54 | libs/automation/src/generators/provider/schema.json | 33,369 | 2024-05-29T17:19:10.590626Z | {
"$id": "Provider",
"$schema": "https://json-schema.org/schema",
"properties": {
"name": {
"$default": {
"$source": "argv",
"index": 0
},
"description": "",
"type": "string",
"x-prompt": "Write the provider name`kebab-cased` (e.g. proton-mail, outlook365, yahoo-mail)?"
},
"type": {
"$default": {
"$source": "argv",
"index": 0
},
"enum": [
"EMAIL",
"SMS",
"PUSH",
"CHAT"
],
"type": "string",
"x-prompt": "Choose the provider type?"
}
},
"required": [
"name"
],
"title": "",
"type": "object"
} | MIT | en |
YDX-2147483647/bulletin-issues-transferred | fc8d3eebcb0dd7b212771950b6a47e4ed6c48256 | 2022-08-20T07:53:02 | config/config.schema.json | 29 | 2024-05-27T05:23:41.584783Z | {
"$id": "config.schema.json-v0.2.2",
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"ding": {
"properties": {
"secrets_path": {
"title": "ding.secrets.yaml \u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"required": [
"secrets_path"
],
"title": "\u9489\u9489\u63d2\u4ef6",
"type": "object"
},
"json_path": {
"default": "output/notices.json",
"title": "\u4ee5 JSON \u683c\u5f0f\u4fdd\u5b58\u901a\u77e5\u65f6\u7684\u6587\u4ef6\u540d",
"type": "string"
},
"proxy": {
"properties": {
"secrets_path": {
"title": "proxy.secrets.yaml \u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"required": [
"secrets_path"
],
"title": "\u865a\u62df\u6821\u56ed\u7f51\u63d2\u4ef6",
"type": "object"
},
"rss": {
"properties": {
"description": {
"title": "\u9891\u9053\u63cf\u8ff0",
"type": "string"
},
"link": {
"format": "uri",
"title": "\u9891\u9053\u94fe\u63a5",
"type": "string"
},
"output_path": {
"examples": [
"output/feed.rss"
],
"title": "\u8f93\u51fa\u6587\u4ef6\u8def\u5f84",
"type": "string"
},
"rss_href": {
"format": "uri",
"title": "RSS \u6587\u4ef6\u5728\u7f51\u7ad9\u4e0a\u7684 URL",
"type": "string"
},
"title": {
"title": "\u9891\u9053\u6807\u9898",
"type": "string"
}
},
"required": [
"title",
"link",
"description",
"rss_href",
"output_path"
],
"title": "RSS \u63d2\u4ef6",
"type": "object"
},
"save_for": {
"default": 90,
"description": "0\u8868\u793a\u6c38\u8fdc\u4fdd\u5b58\u3002",
"title": "\u4fdd\u5b58\u5929\u6570",
"type": "number"
},
"sources_by_selectors_path": {
"default": "config/sources_by_selectors.json",
"title": "\u57fa\u4e8e\u9009\u62e9\u5668\u7684\u901a\u77e5\u6765\u6e90\u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"title": "Bulletin IT \u8bbe\u7f6e",
"type": "object"
} | MIT | zh |
YDX-2147483647/bulletin-issues-transferred | 319ae9718a32b61aa558214f328172e313c7bf1f | 2022-02-20T07:26:30 | config/config.schema.json | 29 | 2024-05-27T05:23:41.584783Z | {
"$id": "config.schema.json-v0.0.1",
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"ding": {
"description": "\u9489\u9489\u63d2\u4ef6",
"properties": {
"secrets_path": {
"description": "ding.secrets.yaml \u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"type": "object"
},
"output": {
"description": "\u8f93\u51fa",
"properties": {
"json_path": {
"default": "output/notices.json",
"description": "\u4ee5 JSON \u683c\u5f0f\u4fdd\u5b58\u901a\u77e5\u65f6\u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"type": "object"
},
"sources_path": {
"default": "config/sources.json",
"description": "\u901a\u77e5\u6765\u6e90\u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"title": "Bulletin IT \u8bbe\u7f6e",
"type": "object"
} | MIT | zh |
YDX-2147483647/bulletin-issues-transferred | 08bbfaac6bff40380afb3d7f234cfc1d46dab093 | 2022-01-23T16:22:46 | config/config.schema.json | 29 | 2024-05-27T05:23:41.584783Z | {
"$id": "config.schema.json-v0.0.1",
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"output": {
"description": "\u8f93\u51fa",
"properties": {
"json_path": {
"default": "output/notices.json",
"description": "\u4ee5 JSON \u683c\u5f0f\u4fdd\u5b58\u901a\u77e5\u65f6\u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"type": "object"
},
"sources_path": {
"default": "config/sources.json",
"description": "\u901a\u77e5\u6765\u6e90\u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"title": "Bulletin IT \u8bbe\u7f6e",
"type": "object"
} | MIT | zh |
YDX-2147483647/bulletin-issues-transferred | 18e9ab20c6aff1635a8bf35f99cd87178acd30ab | 2022-08-05T15:25:33 | config/config.schema.json | 29 | 2024-05-27T05:23:41.584783Z | {
"$id": "config.schema.json-v0.2.1",
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"ding": {
"properties": {
"secrets_path": {
"title": "ding.secrets.yaml \u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"title": "\u9489\u9489\u63d2\u4ef6",
"type": "object"
},
"output": {
"properties": {
"json_path": {
"default": "output/notices.json",
"title": "\u4ee5 JSON \u683c\u5f0f\u4fdd\u5b58\u901a\u77e5\u65f6\u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"title": "\u8f93\u51fa",
"type": "object"
},
"sources_by_selectors_path": {
"default": "config/sources_by_selectors.json",
"title": "\u57fa\u4e8e\u9009\u62e9\u5668\u7684\u901a\u77e5\u6765\u6e90\u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"title": "Bulletin IT \u8bbe\u7f6e",
"type": "object"
} | MIT | zh |
YDX-2147483647/bulletin-issues-transferred | ee13fc6064beb7948c00f0ce999c7ad94b774da7 | 2022-02-21T16:27:34 | config/config.schema.json | 29 | 2024-05-27T05:23:41.584783Z | {
"$id": "config.schema.json-v0.2.0",
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"ding": {
"description": "\u9489\u9489\u63d2\u4ef6",
"properties": {
"secrets_path": {
"description": "ding.secrets.yaml \u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"type": "object"
},
"output": {
"description": "\u8f93\u51fa",
"properties": {
"json_path": {
"default": "output/notices.json",
"description": "\u4ee5 JSON \u683c\u5f0f\u4fdd\u5b58\u901a\u77e5\u65f6\u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"type": "object"
},
"sources_by_selectors_path": {
"default": "config/sources_by_selectors.json",
"description": "\u57fa\u4e8e\u9009\u62e9\u5668\u7684\u901a\u77e5\u6765\u6e90\u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"title": "Bulletin IT \u8bbe\u7f6e",
"type": "object"
} | MIT | zh |
YDX-2147483647/bulletin-issues-transferred | 698255f0d6acf5fa9b58c4809f41a41fe057e6a4 | 2022-08-08T10:55:21 | config/config.schema.json | 29 | 2024-05-27T05:23:41.584783Z | {
"$id": "config.schema.json-v0.2.2",
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"ding": {
"properties": {
"secrets_path": {
"title": "ding.secrets.yaml \u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"required": [
"secrets_path"
],
"title": "\u9489\u9489\u63d2\u4ef6",
"type": "object"
},
"json_path": {
"default": "output/notices.json",
"title": "\u4ee5 JSON \u683c\u5f0f\u4fdd\u5b58\u901a\u77e5\u65f6\u7684\u6587\u4ef6\u540d",
"type": "string"
},
"rss": {
"properties": {
"description": {
"title": "\u9891\u9053\u63cf\u8ff0",
"type": "string"
},
"link": {
"format": "uri",
"title": "\u9891\u9053\u94fe\u63a5",
"type": "string"
},
"output_path": {
"examples": [
"output/feed.rss"
],
"title": "\u8f93\u51fa\u6587\u4ef6\u8def\u5f84",
"type": "string"
},
"rss_href": {
"format": "uri",
"title": "RSS \u6587\u4ef6\u5728\u7f51\u7ad9\u4e0a\u7684 URL",
"type": "string"
},
"title": {
"title": "\u9891\u9053\u6807\u9898",
"type": "string"
}
},
"required": [
"title",
"link",
"description",
"rss_href",
"output_path"
],
"title": "RSS \u63d2\u4ef6",
"type": "object"
},
"save_for": {
"default": 90,
"description": "0\u8868\u793a\u6c38\u8fdc\u4fdd\u5b58\u3002",
"title": "\u4fdd\u5b58\u5929\u6570",
"type": "number"
},
"sources_by_selectors_path": {
"default": "config/sources_by_selectors.json",
"title": "\u57fa\u4e8e\u9009\u62e9\u5668\u7684\u901a\u77e5\u6765\u6e90\u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"title": "Bulletin IT \u8bbe\u7f6e",
"type": "object"
} | MIT | zh |
YDX-2147483647/bulletin-issues-transferred | dffb172514275e6e80f476e48f36e233bc58d8fb | 2023-12-07T06:15:01 | config/config.schema.json | 29 | 2024-05-27T05:23:41.584783Z | {
"$id": "config.schema.json-v0.3.1",
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"ding": {
"properties": {
"secrets_path": {
"title": "ding.secrets.yaml \u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"required": [
"secrets_path"
],
"title": "\u9489\u9489\u63d2\u4ef6",
"type": "object"
},
"json_path": {
"default": "output/notices.json",
"title": "\u4ee5 JSON \u683c\u5f0f\u4fdd\u5b58\u901a\u77e5\u65f6\u7684\u6587\u4ef6\u540d",
"type": "string"
},
"proxy": {
"properties": {
"match": {
"items": {
"examples": [
"dzb.bit.edu.cn"
],
"format": "hostname",
"type": "string"
},
"title": "\u8981\u4ee3\u7406\u7684 hostname \u7684\u5217\u8868",
"type": "array"
},
"secrets_path": {
"title": "proxy.secrets.yaml \u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"required": [
"secrets_path",
"match"
],
"title": "\u865a\u62df\u6821\u56ed\u7f51\u63d2\u4ef6",
"type": "object"
},
"rss": {
"properties": {
"description": {
"title": "\u9891\u9053\u63cf\u8ff0",
"type": "string"
},
"link": {
"format": "uri",
"title": "\u9891\u9053\u94fe\u63a5",
"type": "string"
},
"max_items": {
"default": 30,
"minimum": 0,
"title": "\u5305\u542b\u901a\u77e5\u6570\u91cf\u7684\u4e0a\u9650",
"type": "number"
},
"output_path": {
"examples": [
"output/feed.rss"
],
"title": "\u8f93\u51fa\u6587\u4ef6\u8def\u5f84",
"type": "string"
},
"rss_href": {
"format": "uri",
"title": "RSS \u6587\u4ef6\u5728\u7f51\u7ad9\u4e0a\u7684 URL",
"type": "string"
},
"title": {
"title": "\u9891\u9053\u6807\u9898",
"type": "string"
}
},
"required": [
"title",
"link",
"description",
"rss_href",
"output_path"
],
"title": "RSS \u63d2\u4ef6",
"type": "object"
},
"save_for": {
"default": 90,
"description": "0\u8868\u793a\u6c38\u8fdc\u4fdd\u5b58\u3002",
"title": "\u4fdd\u5b58\u5929\u6570",
"type": "number"
},
"sources_by_selectors_path": {
"default": "config/sources_by_selectors.json",
"title": "\u57fa\u4e8e\u9009\u62e9\u5668\u7684\u901a\u77e5\u6765\u6e90\u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"title": "Bulletin IT \u8bbe\u7f6e",
"type": "object"
} | MIT | zh |
YDX-2147483647/bulletin-issues-transferred | b05a23d0ad6b7395f9391939d636b9524b497b19 | 2023-02-24T03:12:37 | config/config.schema.json | 29 | 2024-05-27T05:23:41.584783Z | {
"$id": "config.schema.json-v0.3.1",
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"ding": {
"properties": {
"secrets_path": {
"title": "ding.secrets.yaml \u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"required": [
"secrets_path"
],
"title": "\u9489\u9489\u63d2\u4ef6",
"type": "object"
},
"json_path": {
"default": "output/notices.json",
"title": "\u4ee5 JSON \u683c\u5f0f\u4fdd\u5b58\u901a\u77e5\u65f6\u7684\u6587\u4ef6\u540d",
"type": "string"
},
"proxy": {
"properties": {
"match": {
"items": {
"examples": [
"dekt.bit.edu.cn"
],
"format": "hostname",
"type": "string"
},
"title": "\u8981\u4ee3\u7406\u7684 hostname \u7684\u5217\u8868",
"type": "array"
},
"secrets_path": {
"title": "proxy.secrets.yaml \u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"required": [
"secrets_path",
"match"
],
"title": "\u865a\u62df\u6821\u56ed\u7f51\u63d2\u4ef6",
"type": "object"
},
"rss": {
"properties": {
"description": {
"title": "\u9891\u9053\u63cf\u8ff0",
"type": "string"
},
"link": {
"format": "uri",
"title": "\u9891\u9053\u94fe\u63a5",
"type": "string"
},
"max_items": {
"default": 30,
"minimum": 0,
"title": "\u5305\u542b\u901a\u77e5\u6570\u91cf\u7684\u4e0a\u9650",
"type": "number"
},
"output_path": {
"examples": [
"output/feed.rss"
],
"title": "\u8f93\u51fa\u6587\u4ef6\u8def\u5f84",
"type": "string"
},
"rss_href": {
"format": "uri",
"title": "RSS \u6587\u4ef6\u5728\u7f51\u7ad9\u4e0a\u7684 URL",
"type": "string"
},
"title": {
"title": "\u9891\u9053\u6807\u9898",
"type": "string"
}
},
"required": [
"title",
"link",
"description",
"rss_href",
"output_path"
],
"title": "RSS \u63d2\u4ef6",
"type": "object"
},
"save_for": {
"default": 90,
"description": "0\u8868\u793a\u6c38\u8fdc\u4fdd\u5b58\u3002",
"title": "\u4fdd\u5b58\u5929\u6570",
"type": "number"
},
"sources_by_selectors_path": {
"default": "config/sources_by_selectors.json",
"title": "\u57fa\u4e8e\u9009\u62e9\u5668\u7684\u901a\u77e5\u6765\u6e90\u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"title": "Bulletin IT \u8bbe\u7f6e",
"type": "object"
} | MIT | zh |
YDX-2147483647/bulletin-issues-transferred | d20c6412c67c2e39a4a352b32b2bf83d44822b9d | 2022-08-20T08:50:19 | config/config.schema.json | 29 | 2024-05-27T05:23:41.584783Z | {
"$id": "config.schema.json-v0.3.0",
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"ding": {
"properties": {
"secrets_path": {
"title": "ding.secrets.yaml \u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"required": [
"secrets_path"
],
"title": "\u9489\u9489\u63d2\u4ef6",
"type": "object"
},
"json_path": {
"default": "output/notices.json",
"title": "\u4ee5 JSON \u683c\u5f0f\u4fdd\u5b58\u901a\u77e5\u65f6\u7684\u6587\u4ef6\u540d",
"type": "string"
},
"proxy": {
"properties": {
"match": {
"items": {
"examples": [
"dekt.bit.edu.cn"
],
"format": "hostname",
"type": "string"
},
"title": "\u8981\u4ee3\u7406\u7684 hostname \u7684\u5217\u8868",
"type": "array"
},
"secrets_path": {
"title": "proxy.secrets.yaml \u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"required": [
"secrets_path",
"match"
],
"title": "\u865a\u62df\u6821\u56ed\u7f51\u63d2\u4ef6",
"type": "object"
},
"rss": {
"properties": {
"description": {
"title": "\u9891\u9053\u63cf\u8ff0",
"type": "string"
},
"link": {
"format": "uri",
"title": "\u9891\u9053\u94fe\u63a5",
"type": "string"
},
"output_path": {
"examples": [
"output/feed.rss"
],
"title": "\u8f93\u51fa\u6587\u4ef6\u8def\u5f84",
"type": "string"
},
"rss_href": {
"format": "uri",
"title": "RSS \u6587\u4ef6\u5728\u7f51\u7ad9\u4e0a\u7684 URL",
"type": "string"
},
"title": {
"title": "\u9891\u9053\u6807\u9898",
"type": "string"
}
},
"required": [
"title",
"link",
"description",
"rss_href",
"output_path"
],
"title": "RSS \u63d2\u4ef6",
"type": "object"
},
"save_for": {
"default": 90,
"description": "0\u8868\u793a\u6c38\u8fdc\u4fdd\u5b58\u3002",
"title": "\u4fdd\u5b58\u5929\u6570",
"type": "number"
},
"sources_by_selectors_path": {
"default": "config/sources_by_selectors.json",
"title": "\u57fa\u4e8e\u9009\u62e9\u5668\u7684\u901a\u77e5\u6765\u6e90\u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"title": "Bulletin IT \u8bbe\u7f6e",
"type": "object"
} | MIT | zh |
YDX-2147483647/bulletin-issues-transferred | 093f227bc6c10e8f5869b00a7d1b725743c9ac9b | 2022-08-08T07:39:35 | config/config.schema.json | 29 | 2024-05-27T05:23:41.584783Z | {
"$id": "config.schema.json-v0.2.2",
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"ding": {
"properties": {
"secrets_path": {
"title": "ding.secrets.yaml \u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"required": [
"secrets_path"
],
"title": "\u9489\u9489\u63d2\u4ef6",
"type": "object"
},
"json_path": {
"default": "output/notices.json",
"title": "\u4ee5 JSON \u683c\u5f0f\u4fdd\u5b58\u901a\u77e5\u65f6\u7684\u6587\u4ef6\u540d",
"type": "string"
},
"rss": {
"properties": {
"description": {
"title": "\u9891\u9053\u63cf\u8ff0",
"type": "string"
},
"link": {
"format": "uri",
"title": "\u9891\u9053\u94fe\u63a5",
"type": "string"
},
"output_path": {
"examples": [
"output/feed.rss"
],
"title": "\u8f93\u51fa\u6587\u4ef6\u8def\u5f84",
"type": "string"
},
"rss_href": {
"format": "uri",
"title": "RSS \u6587\u4ef6\u5728\u7f51\u7ad9\u4e0a\u7684 URL",
"type": "string"
},
"title": {
"title": "\u9891\u9053\u6807\u9898",
"type": "string"
}
},
"required": [
"title",
"link",
"description",
"rss_href",
"output_path"
],
"title": "RSS \u63d2\u4ef6",
"type": "object"
},
"sources_by_selectors_path": {
"default": "config/sources_by_selectors.json",
"title": "\u57fa\u4e8e\u9009\u62e9\u5668\u7684\u901a\u77e5\u6765\u6e90\u7684\u6587\u4ef6\u540d",
"type": "string"
}
},
"title": "Bulletin IT \u8bbe\u7f6e",
"type": "object"
} | MIT | zh |
SuperFlyTV/GraphicsDataDefinition | 6c666620fee2d4f7d0107fd0f6a4c1e8e2bdbccc | 2022-11-04T14:39:55 | gdd-meta-schema/v1/lib/basic-types.json | 13 | 2024-05-27T06:41:06.36062Z | {
"$id": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/lib/basic-types.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "boolean"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"default": {
"type": "boolean"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "string"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"default": {
"type": "string"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "number"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"default": {
"type": "number"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "integer"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"default": {
"type": "integer"
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "array"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"default": {
"type": "array"
},
"items": {
"$ref": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/lib/object.json",
"type": "object"
}
},
"required": [
"items"
]
}
},
{
"if": {
"properties": {
"type": {
"const": "object"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"default": {
"type": "object"
},
"properties": {
"additionalProperties": false,
"patternProperties": {
".": {
"$ref": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/lib/object.json",
"type": "object"
}
},
"type": "object"
}
},
"required": [
"properties"
]
}
}
]
} | MIT | en |
SuperFlyTV/GraphicsDataDefinition | d55a23786c342590048db0750269e2f67c3b769a | 2022-11-04T18:32:44 | gdd-meta-schema/v1/schema.json | 13 | 2024-05-27T06:41:06.36062Z | {
"$id": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "https://json-schema.org/draft/2020-12/schema"
}
],
"properties": {
"$schema": {
"const": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/schema.json",
"description": "Reference to the JSON-schema",
"type": "string"
},
"description": {
"description": "A description GFX-template. Used for informational purposes only.",
"type": "string"
},
"gddPlayoutOptions": {
"$ref": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/lib/playout-options.json",
"type": "object"
},
"properties": {
"patternProperties": {
".": {
"$ref": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/lib/object.json",
"type": "object"
}
},
"type": "object"
},
"title": {
"description": "A short name of the GFX-template. Used for informational purposes only.",
"type": "string"
},
"type": {
"enum": [
"object"
],
"type": "string"
}
},
"required": [
"properties"
],
"type": "object"
} | MIT | en |
SuperFlyTV/GraphicsDataDefinition | bfc21d8923fa44bf5ad934ca0aa63579e3178027 | 2022-11-04T18:50:25 | gdd-meta-schema/v1/schema.json | 13 | 2024-05-27T06:41:06.36062Z | {
"$id": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "https://json-schema.org/draft/2020-12/schema"
}
],
"properties": {
"$schema": {
"const": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/schema.json",
"description": "Reference to the JSON-schema",
"type": "string"
},
"authorEmail": {
"description": "Email to the author",
"format": "email",
"type": "string"
},
"authorName": {
"description": "Name of the author",
"type": "string"
},
"description": {
"description": "A description GFX-template. Used for informational purposes only.",
"type": "string"
},
"gddPlayoutOptions": {
"$ref": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/lib/playout-options.json",
"type": "object"
},
"properties": {
"patternProperties": {
".": {
"$ref": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/lib/object.json",
"type": "object"
}
},
"type": "object"
},
"title": {
"description": "A short name of the GFX-template. Used for informational purposes only.",
"type": "string"
},
"type": {
"enum": [
"object"
],
"type": "string"
}
},
"required": [
"properties"
],
"type": "object"
} | MIT | en |
SuperFlyTV/GraphicsDataDefinition | 6c666620fee2d4f7d0107fd0f6a4c1e8e2bdbccc | 2022-11-04T14:39:55 | gdd-meta-schema/v1/schema.json | 13 | 2024-05-27T06:41:06.36062Z | {
"$id": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "https://json-schema.org/draft/2020-12/schema"
}
],
"properties": {
"$schema": {
"type": "string"
},
"description": {
"type": "string"
},
"gddPlayoutOptions": {
"$ref": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/lib/playout-options.json",
"type": "object"
},
"properties": {
"patternProperties": {
".": {
"$ref": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/lib/object.json",
"type": "object"
}
},
"type": "object"
},
"title": {
"type": "string"
},
"type": {
"enum": [
"object"
],
"type": "string"
}
},
"required": [
"properties"
],
"type": "object"
} | MIT | en |
SuperFlyTV/GraphicsDataDefinition | 4fddd7021671b31b45480cec7b75485a4ba91ea3 | 2022-11-04T15:40:47 | gdd-meta-schema/v1/lib/gdd-types.json | 13 | 2024-05-27T06:41:06.36062Z | {
"$id": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/lib/gdd-types.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"if": {
"properties": {
"gddType": {
"const": "single-line"
}
},
"required": [
"gddType"
]
},
"then": {
"properties": {
"type": {
"const": "string"
}
}
}
},
{
"if": {
"properties": {
"gddType": {
"const": "multi-line"
}
},
"required": [
"gddType"
]
},
"then": {
"properties": {
"type": {
"const": "string"
}
}
}
},
{
"if": {
"properties": {
"gddType": {
"const": "file-path"
}
},
"required": [
"gddType"
]
},
"then": {
"properties": {
"gddOptions": {
"properties": {
"extensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": {
"const": "string"
}
}
}
},
{
"if": {
"properties": {
"gddType": {
"const": "file-path/image-path"
}
},
"required": [
"gddType"
]
},
"then": {
"properties": {
"gddOptions": {
"properties": {
"extensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": {
"const": "string"
}
}
}
},
{
"if": {
"properties": {
"gddType": {
"const": "select"
}
},
"required": [
"gddType"
]
},
"then": {
"properties": {
"gddOptions": {
"properties": {},
"required": [
"labels"
],
"type": "object"
},
"type": {
"enum": [
"string",
"number",
"integer"
]
}
},
"required": [
"gddOptions",
"enum"
]
}
},
{
"if": {
"properties": {
"gddType": {
"const": "select"
},
"type": {
"const": "string"
}
},
"required": [
"gddType",
"type"
]
},
"then": {
"properties": {
"enum": {
"items": {
"type": "string"
},
"type": "array"
},
"gddOptions": {
"properties": {},
"type": "object"
}
},
"required": [
"gddOptions",
"enum"
]
}
},
{
"if": {
"properties": {
"gddType": {
"const": "select"
},
"type": {
"const": "integer"
}
},
"required": [
"gddType",
"type"
]
},
"then": {
"properties": {
"enum": {
"items": {
"type": "integer"
},
"type": "array"
},
"gddOptions": {
"properties": {
"labels": {
"additionalProperties": false,
"patternProperties": {
".": {
"type": "string"
}
},
"propertyNames": {
"pattern": "^[0-9]+$"
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"gddOptions",
"enum"
]
}
},
{
"if": {
"properties": {
"gddType": {
"const": "select"
},
"type": {
"const": "number"
}
},
"required": [
"gddType",
"type"
]
},
"then": {
"properties": {
"enum": {
"items": {
"type": "number"
},
"type": "array"
},
"gddOptions": {
"properties": {
"labels": {
"patternProperties": {
".": {
"type": "string"
}
},
"propertyNames": {
"pattern": "^[0-9,.]+$"
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"gddOptions",
"enum"
]
}
},
{
"if": {
"properties": {
"gddType": {
"const": "color-rrggbb"
}
},
"required": [
"gddType"
]
},
"then": {
"properties": {
"pattern": {
"const": "^#[0-9a-f]{6}$",
"type": "string"
},
"type": {
"const": "string"
}
},
"required": [
"pattern"
]
}
},
{
"if": {
"properties": {
"gddType": {
"const": "color-rrggbbaa"
}
},
"required": [
"gddType"
]
},
"then": {
"properties": {
"pattern": {
"const": "^#[0-9a-f]{8}$",
"type": "string"
},
"type": {
"const": "string"
}
},
"required": [
"pattern"
]
}
},
{
"if": {
"properties": {
"gddType": {
"const": "percentage"
}
},
"required": [
"gddType"
]
},
"then": {
"properties": {
"type": {
"const": "number"
}
}
}
},
{
"if": {
"properties": {
"gddType": {
"const": "duration-ms"
}
},
"required": [
"gddType"
]
},
"then": {
"properties": {
"type": {
"const": "integer"
}
}
}
}
]
} | MIT | en |
SuperFlyTV/GraphicsDataDefinition | ea3e04b4fcf44e00b93bd80fef0180d8ee96f3e8 | 2022-11-04T18:27:30 | gdd-meta-schema/v1/schema.json | 13 | 2024-05-27T06:41:06.36062Z | {
"$id": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "https://json-schema.org/draft/2020-12/schema"
}
],
"properties": {
"$schema": {
"type": "string"
},
"authorEmail": {
"description": "Email to the author",
"format": "email",
"type": "string"
},
"authorName": {
"description": "Name of the author",
"type": "string"
},
"description": {
"type": "string"
},
"gddPlayoutOptions": {
"$ref": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/lib/playout-options.json",
"type": "object"
},
"properties": {
"patternProperties": {
".": {
"$ref": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/lib/object.json",
"type": "object"
}
},
"type": "object"
},
"title": {
"type": "string"
},
"type": {
"enum": [
"object"
],
"type": "string"
}
},
"required": [
"properties"
],
"type": "object"
} | MIT | en |
SuperFlyTV/GraphicsDataDefinition | 823e4a0f084822231d4e3d7fad13b58eeaf4069d | 2022-11-04T19:31:29 | gdd-meta-schema/v1/lib/playout-options.json | 13 | 2024-05-27T06:41:06.36062Z | {
"$id": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/lib/playout-options.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"client": {
"properties": {
"dataformat": {
"description": "How the data should be formatted. This is mostly used for the older CasparCG flash-based xml data format. Defaults to \"json\"",
"enum": [
"json",
"casparcg-xml"
],
"type": "string"
},
"duration": {
"description": "The suggested duration of the template (in milliseconds). null means that it is manually taken out, undefined should be treated as null (this is ignored if steps=0). Defaults to null.",
"type": [
"integer",
"null"
]
},
"steps": {
"description": "Number of steps in the template. 1 means that there are no steps (ie there's only \"the default step\"). 2 or more means that it can be \"stepped\" (ie 2 means it can be stepped once). -1 means \"infinite\" number of steps. 0 means that the template is \"volatile\" / \"fire and forget\" (template really has no duration, like a bumper). Defaults to 1",
"type": "integer"
}
},
"type": "object"
},
"playout": {
"type": "object"
},
"render": {
"properties": {
"resolutions": {
"items": {
"patternProperties": {
"width|height|framerate": {
"allOf": [
{
"if": {
"type": "object"
},
"then": {
"properties": {
"max": {
"type": "number"
},
"min": {
"type": "number"
}
}
}
}
],
"type": [
"number",
"object"
]
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
SuperFlyTV/GraphicsDataDefinition | 6c666620fee2d4f7d0107fd0f6a4c1e8e2bdbccc | 2022-11-04T14:39:55 | gdd-meta-schema/v1/lib/gdd-types.json | 13 | 2024-05-27T06:41:06.36062Z | {
"$id": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/lib/gdd-types.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"if": {
"properties": {
"gddType": {
"const": "single-line"
}
},
"required": [
"gddType"
]
},
"then": {
"properties": {
"type": {
"const": "string"
}
}
}
},
{
"if": {
"properties": {
"gddType": {
"const": "multi-line"
}
},
"required": [
"gddType"
]
},
"then": {
"properties": {
"type": {
"const": "string"
}
}
}
},
{
"if": {
"properties": {
"gddType": {
"const": "file-path"
}
},
"required": [
"gddType"
]
},
"then": {
"properties": {
"gddOptions": {
"properties": {
"extensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": {
"const": "string"
}
}
}
},
{
"if": {
"properties": {
"gddType": {
"const": "file-path/image-path"
}
},
"required": [
"gddType"
]
},
"then": {
"properties": {
"gddOptions": {
"properties": {
"extensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": {
"const": "string"
}
}
}
},
{
"if": {
"properties": {
"gddType": {
"const": "select"
}
},
"required": [
"gddType"
]
},
"then": {
"properties": {
"gddOptions": {
"properties": {},
"required": [
"labels"
],
"type": "object"
},
"type": {
"enum": [
"string",
"number",
"integer"
]
}
},
"required": [
"gddOptions",
"enum"
]
}
},
{
"if": {
"properties": {
"gddType": {
"const": "select"
},
"type": {
"const": "string"
}
},
"required": [
"gddType",
"type"
]
},
"then": {
"properties": {
"enum": {
"items": {
"type": "string"
},
"type": "array"
},
"gddOptions": {
"properties": {},
"type": "object"
}
},
"required": [
"gddOptions",
"enum"
]
}
},
{
"if": {
"properties": {
"gddType": {
"const": "select"
},
"type": {
"const": "integer"
}
},
"required": [
"gddType",
"type"
]
},
"then": {
"properties": {
"enum": {
"items": {
"type": "integer"
},
"type": "array"
},
"gddOptions": {
"properties": {
"labels": {
"additionalProperties": false,
"patternProperties": {
".": {
"type": "string"
}
},
"propertyNames": {
"pattern": "^[0-9]+$"
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"gddOptions",
"enum"
]
}
},
{
"if": {
"properties": {
"gddType": {
"const": "select"
},
"type": {
"const": "number"
}
},
"required": [
"gddType",
"type"
]
},
"then": {
"properties": {
"enum": {
"items": {
"type": "number"
},
"type": "array"
},
"gddOptions": {
"properties": {
"labels": {
"patternProperties": {
".": {
"type": "string"
}
},
"propertyNames": {
"pattern": "^[0-9,.]+$"
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"gddOptions",
"enum"
]
}
},
{
"if": {
"properties": {
"gddType": {
"const": "color-rrggbb"
}
},
"required": [
"gddType"
]
},
"then": {
"properties": {
"pattern": {
"const": "^#[0-9a-f]{6}$",
"type": "string"
},
"type": {
"const": "string"
}
},
"required": [
"pattern"
]
}
},
{
"if": {
"properties": {
"gddType": {
"const": "percentage"
}
},
"required": [
"gddType"
]
},
"then": {
"properties": {
"type": {
"const": "number"
}
}
}
},
{
"if": {
"properties": {
"gddType": {
"const": "duration-ms"
}
},
"required": [
"gddType"
]
},
"then": {
"properties": {
"type": {
"const": "integer"
}
}
}
}
]
} | MIT | en |
SuperFlyTV/GraphicsDataDefinition | 33decb0d8de343391f895aed60683ef25bb1ff96 | 2022-11-04T05:46:27 | gdd-meta-schema/v1/schema.json | 13 | 2024-05-27T06:41:06.36062Z | {
"$id": "gdd-meta-schema",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "https://json-schema.org/draft/2020-12/schema"
}
],
"properties": {
"properties": {
"additionalProperties0": false,
"patternProperties": {
".": {
"allOf": [
{
"$ref": "./lib/object.json"
}
],
"type": "object"
}
},
"type": "object"
},
"type": {
"enum": [
"object"
],
"type": "string"
}
},
"type": "object"
} | MIT | en |
SuperFlyTV/GraphicsDataDefinition | 6c666620fee2d4f7d0107fd0f6a4c1e8e2bdbccc | 2022-11-04T14:39:55 | gdd-meta-schema/v1/lib/object.json | 13 | 2024-05-27T06:41:06.36062Z | {
"$id": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/lib/object.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "https://json-schema.org/draft/2020-12/schema"
},
{
"$ref": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/lib/gdd-types.json"
},
{
"$ref": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/lib/basic-types.json"
}
],
"properties": {
"gddOptions": {
"type": "object"
},
"gddType": {
"type": "string"
},
"type": {
"enum": [
"boolean",
"string",
"number",
"integer",
"array",
"object"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
} | MIT | en |
SuperFlyTV/GraphicsDataDefinition | 6c666620fee2d4f7d0107fd0f6a4c1e8e2bdbccc | 2022-11-04T14:39:55 | gdd-meta-schema/v1/lib/playout-options.json | 13 | 2024-05-27T06:41:06.36062Z | {
"$id": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/lib/playout-options.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"client": {
"properties": {
"dataformat": {
"description": "How the data should be formatted. This is mostly used for the older CasparCG flash-based xml data format. Defaults to \"json\"",
"enum": [
"json",
"casparcg-xml"
],
"type": "string"
},
"duration": {
"description": "The suggested duration of the template (in milliseconds). null means that it is manually taken out, undefined should be treated as null (this is ignored if steps=0). Defaults to null.",
"type": [
"integer",
"null"
]
},
"steps": {
"description": "Number of steps in the template. 1 means that there are no steps (ie there's only \"the default step\"). 2 or more means that it can be \"stepped\" (ie 2 means it can be stepped once). -1 means \"infinite\" number of steps. 0 means that the template is \"volatile\" / \"fire and forget\" (template really has no duration, like a bumper). Defaults to 1",
"type": "integer"
}
},
"type": "object"
},
"playout": {
"type": "object"
}
},
"type": "object"
} | MIT | en |
SuperFlyTV/GraphicsDataDefinition | 33decb0d8de343391f895aed60683ef25bb1ff96 | 2022-11-04T05:46:27 | gdd-meta-schema/v1/lib/gdd-types.json | 13 | 2024-05-27T06:41:06.36062Z | {
"$id": "gdd-meta-schema/gddTypes",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"if": {
"properties": {
"gddType": {
"const": "file-path"
}
},
"required": [
"gddType"
]
},
"then": {
"properties": {
"gddOptions": {
"properties": {
"extensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": {
"const": "string"
}
}
}
},
{
"if": {
"properties": {
"gddType": {
"const": "file-path/image-path"
}
},
"required": [
"gddType"
]
},
"then": {
"properties": {
"gddOptions": {
"properties": {
"extensions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": {
"const": "string"
}
}
}
},
{
"if": {
"properties": {
"gddType": {
"const": "color-rrggbb"
}
},
"required": [
"gddType"
]
},
"then": {
"properties": {
"pattern": {
"const": "^#[0-9a-f]{6}$",
"type": "string"
},
"type": {
"const": "string"
}
},
"required": [
"pattern"
]
}
}
]
} | MIT | en |
SuperFlyTV/GraphicsDataDefinition | 33decb0d8de343391f895aed60683ef25bb1ff96 | 2022-11-04T05:46:27 | gdd-meta-schema/v1/lib/object.json | 13 | 2024-05-27T06:41:06.36062Z | {
"$id": "gdd-meta-schema/object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "https://json-schema.org/draft/2020-12/schema"
},
{
"$ref": "./gdd-types.json"
}
],
"properties": {
"gddOptions": {
"type": "object"
},
"gddType": {
"type": "string"
},
"type": {
"enum": [
"boolean",
"string",
"number",
"integer",
"array",
"object"
],
"type": [
"string",
"array"
]
}
},
"type": "object"
} | MIT | en |
elyra-ai/canvas | f94a9007613d19d2d7e19926a7bcc7fce0690161 | 2021-03-09T21:57:04 | canvas_modules/common-canvas/src/object-model/schemas/v2/pipeline-flow-v2-schema.json | 38 | 2024-05-29T16:37:55.377088Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"app_data_def": {
"additionalProperties": true,
"description": "Object containing app-specific data",
"properties": {
"ui_data": {
"anyOf": [
{
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/pipeline_overview_def"
},
{
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/pipeline_def"
},
{
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/port_info_def"
},
{
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/node_info_def"
},
{
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/runtime_info_def"
}
]
}
},
"type": "object"
},
"binding_entry_node_def": {
"additionalProperties": false,
"description": "Defines an entry point (source) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"op": {
"description": "Binding node type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the entry binding node",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"binding_exit_node_def": {
"additionalProperties": false,
"description": "Defines an exit point (sink) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Binding node type identifier",
"type": "string"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the binding exit node",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"bound_port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node with optional pipeline port binding for supernodes",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the binding port",
"properties": {},
"type": "object"
},
"schema_ref": {
"description": "Optional data record schema associated with the port",
"type": "string"
},
"subflow_node_ref": {
"description": "Optional node id binding within the current document.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"bound_ports_def": {
"items": {
"$ref": "#/definitions/bound_port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"link_def": {
"additionalProperties": false,
"description": "Node link definition",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"link_name": {
"description": "optional link name (used in parameter sets when there are multiple input sources)",
"type": "string"
},
"node_id_ref": {
"description": "id of a node this link connects to",
"type": "string"
},
"port_id_ref": {
"description": "optional port id of a node this link connects to",
"type": "string"
}
},
"required": [
"node_id_ref"
],
"type": "object"
},
"model_node_def": {
"additionalProperties": false,
"description": "Definition of a single predictive model node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the model within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"model_ref": {
"description": "Reference to the binary model",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Reference to the runtime associated with the current node",
"type": "string"
},
"type": {
"description": "Node type - always 'model_node' for model pipeline elements",
"enum": [
"model_node"
]
}
},
"required": [
"id",
"type",
"inputs"
],
"type": "object"
},
"node_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for node within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Operator type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Optional reference to the id of the runtime associated with the current node",
"type": "string"
},
"type": {
"description": "Node type - always 'execution_node' for non-model pipeline elements",
"enum": [
"execution_node"
]
}
},
"required": [
"id",
"type",
"op"
],
"type": "object"
},
"pipeline_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline flow",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "User-readable name",
"type": "string"
},
"nodes": {
"description": "Array of pipeline nodes",
"items": {
"oneOf": [
{
"$ref": "#/definitions/node_def"
},
{
"$ref": "#/definitions/supernode_def"
},
{
"$ref": "#/definitions/binding_entry_node_def"
},
{
"$ref": "#/definitions/binding_exit_node_def"
},
{
"$ref": "#/definitions/model_node_def"
}
]
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the pipeline",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Reference to the id of the runtime associated with the operations in the current pipeline",
"type": "string"
}
},
"required": [
"id",
"runtime_ref",
"nodes"
],
"type": "object"
},
"port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the port",
"properties": {},
"type": "object"
},
"schema_ref": {
"description": "Optional data record schema reference associated with the port",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"ports_def": {
"items": {
"$ref": "#/definitions/port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"runtime_def": {
"description": "Runtime associated with the operations in the current pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique internal runtime identifier",
"type": "string"
},
"name": {
"description": "The runtime name",
"type": "string"
},
"version": {
"description": "The runtime version. When not present the latest version is assumed",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"supernode_def": {
"additionalProperties": false,
"description": "Definition of a supernode which serves as the entry point for a sub-pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the supernode within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/bound_ports_def"
},
"open_with_tool": {
"description": "Name of the tool which can be used to view or edit the sub-flow for this supernode. The default is 'canvas'",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/bound_ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the supernode",
"properties": {},
"type": "object"
},
"subflow_ref": {
"description": "Refers to the sub-flow associated with this supernode",
"properties": {
"pipeline_id_ref": {
"description": "Sub-flow identifier reference",
"type": "string"
},
"url": {
"description": "Reference to an external sub-flow. When not present the sub-flow is assumed to be in the current document. A value of 'app_defined' indicates a sub-flow identifier is present, but the controlling application will serve up the sub-pipeline in the form of a new pipeline-flow document (no sub-flow is present in the document).",
"type": "string"
}
},
"required": [
"pipeline_id_ref"
],
"type": "object"
},
"type": {
"description": "Node type - always 'super_node' for supernode elements",
"enum": [
"super_node"
]
}
},
"required": [
"id",
"type",
"subflow_ref",
"inputs"
],
"type": "object"
}
},
"description": "WDP Pipeline Flow Schema",
"id": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-v2-schema.json",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"doc_type": {
"description": "Document type",
"type": "string"
},
"external_parameters": {
"description": "Array of parameterized property references",
"items": {
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/parameters/parameters-v2-schema.json#/definitions/param_property_ref"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"id": {
"description": "Document identifier, GUID recommended",
"type": "string"
},
"json_schema": {
"description": "Refers to the JSON schema used to validate documents of this type",
"enum": [
"https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-v2-schema.json"
]
},
"open_with_tool": {
"description": "Preferred authoring application",
"type": "string"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the flow document",
"properties": {},
"type": "object"
},
"pipelines": {
"description": "Array of pipelines",
"items": {
"$ref": "#/definitions/pipeline_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"primary_pipeline": {
"description": "Reference to the primary (main) pipeline flow within the document",
"type": "string"
},
"runtimes": {
"description": "Array of runtime objects referred to in the document",
"items": {
"$ref": "#/definitions/runtime_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"schemas": {
"description": "Array of data record schemas used in the document",
"items": {
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/datarecord-metadata/datarecord-metadata-v2-schema.json#/definitions/record_schema"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"version": {
"description": "Pipeline-flow schema version",
"enum": [
"2.0"
]
}
},
"required": [
"doc_type",
"version",
"primary_pipeline",
"pipelines"
],
"type": "object"
} | Apache-2.0 | en |
elyra-ai/canvas | 20562ae4b8105611ddc2f3db72a4c5077851ea8e | 2018-08-07T13:58:12 | canvas_modules/common-canvas/src/object-model/schemas/v2/pipeline-flow-v2-schema.json | 38 | 2024-05-29T16:37:55.377088Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"app_data_def": {
"additionalProperties": true,
"description": "Object containing app-specific data",
"properties": {
"ui_data": {
"anyOf": [
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/pipeline_overview"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/pipeline_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/port_info_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/node_info_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/runtime_info_def"
}
]
}
},
"type": "object"
},
"binding_entry_node_def": {
"additionalProperties": false,
"description": "Defines an entry point (source) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"op": {
"description": "Binding node type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the entry binding node",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"binding_exit_node_def": {
"additionalProperties": false,
"description": "Defines an exit point (sink) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Binding node type identifier",
"type": "string"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the binding exit node",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"bound_port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node with optional pipeline port binding for supernodes",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the binding port",
"properties": {},
"type": "object"
},
"schema_ref": {
"description": "Optional data record schema associated with the port",
"type": "string"
},
"subflow_node_ref": {
"description": "Optional node id binding within the current document.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"bound_ports_def": {
"items": {
"$ref": "#/definitions/bound_port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"link_def": {
"additionalProperties": false,
"description": "Node link definition",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"link_name": {
"description": "optional link name (used in parameter sets when there are multiple input sources)",
"type": "string"
},
"node_id_ref": {
"description": "id of a node this link connects to",
"type": "string"
},
"port_id_ref": {
"description": "optional port id of a node this link connects to",
"type": "string"
}
},
"required": [
"node_id_ref"
],
"type": "object"
},
"model_node_def": {
"additionalProperties": false,
"description": "Definition of a single predictive model node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the model within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"model_ref": {
"description": "Reference to the binary model",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Reference to the runtime associated with the current node",
"type": "string"
},
"type": {
"description": "Node type - always 'model_node' for model pipeline elements",
"enum": [
"model_node"
]
}
},
"required": [
"id",
"type",
"inputs"
],
"type": "object"
},
"node_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for node within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Operator type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Optional reference to the id of the runtime associated with the current node",
"type": "string"
},
"type": {
"description": "Node type - always 'execution_node' for non-model pipeline elements",
"enum": [
"execution_node"
]
}
},
"required": [
"id",
"type",
"op"
],
"type": "object"
},
"pipeline_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline flow",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "User-readable name",
"type": "string"
},
"nodes": {
"description": "Array of pipeline nodes",
"items": {
"oneOf": [
{
"$ref": "#/definitions/node_def"
},
{
"$ref": "#/definitions/supernode_def"
},
{
"$ref": "#/definitions/binding_entry_node_def"
},
{
"$ref": "#/definitions/binding_exit_node_def"
},
{
"$ref": "#/definitions/model_node_def"
}
]
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the pipeline",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Reference to the id of the runtime associated with the operations in the current pipeline",
"type": "string"
}
},
"required": [
"id",
"runtime_ref",
"nodes"
],
"type": "object"
},
"port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the port",
"properties": {},
"type": "object"
},
"schema_ref": {
"description": "Optional data record schema reference associated with the port",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"ports_def": {
"items": {
"$ref": "#/definitions/port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"runtime_def": {
"description": "Runtime associated with the operations in the current pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique internal runtime identifier",
"type": "string"
},
"name": {
"description": "The runtime name",
"type": "string"
},
"version": {
"description": "The runtime version. When not present the latest version is assumed",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"supernode_def": {
"additionalProperties": false,
"description": "Definition of a supernode which serves as the entry point for a sub-pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the supernode within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/bound_ports_def"
},
"open_with_tool": {
"description": "Sub-flow editing type. The default is 'canvas'",
"enum": [
"canvas",
"shaper"
]
},
"outputs": {
"$ref": "#/definitions/bound_ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the supernode",
"properties": {},
"type": "object"
},
"subflow_ref": {
"description": "Refers to the sub-flow associated with this supernode",
"properties": {
"pipeline_id_ref": {
"description": "Sub-flow identifier reference",
"type": "string"
},
"url": {
"description": "Reference to an external sub-flow. When not present the sub-flow is assumed to be in the current document. A value of 'app_defined' indicates a sub-flow identifier is present, but the controlling application will serve up the sub-pipeline in the form of a new pipeline-flow document (no sub-flow is present in the document).",
"type": "string"
}
},
"required": [
"pipeline_id_ref"
],
"type": "object"
},
"type": {
"description": "Node type - always 'super_node' for supernode elements",
"enum": [
"super_node"
]
}
},
"required": [
"id",
"type",
"subflow_ref",
"inputs"
],
"type": "object"
}
},
"description": "WDP Pipeline Flow Schema",
"id": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-v2-schema.json",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"doc_type": {
"description": "Document type",
"type": "string"
},
"external_parameters": {
"description": "Array of parameterized property references",
"items": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/parameters/parameters-v2-schema.json#/definitions/param_property_ref"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"id": {
"description": "Document identifier, GUID recommended",
"type": "string"
},
"json_schema": {
"description": "Refers to the JSON schema used to validate documents of this type",
"enum": [
"http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-v2-schema.json"
]
},
"open_with_tool": {
"description": "Preferred authoring application",
"type": "string"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the flow document",
"properties": {},
"type": "object"
},
"pipelines": {
"description": "Array of pipelines",
"items": {
"$ref": "#/definitions/pipeline_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"primary_pipeline": {
"description": "Reference to the primary (main) pipeline flow within the document",
"type": "string"
},
"runtimes": {
"description": "Array of runtime objects referred to in the document",
"items": {
"$ref": "#/definitions/runtime_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"schemas": {
"description": "Array of data record schemas used in the document",
"items": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/datarecord-metadata/datarecord-metadata-v2-schema.json#/definitions/record_schema"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"version": {
"description": "Pipeline-flow schema version",
"enum": [
"2.0"
]
}
},
"required": [
"doc_type",
"version",
"primary_pipeline",
"pipelines"
],
"type": "object"
} | Apache-2.0 | en |
elyra-ai/canvas | 0ac0e87ff80c85a46db63ae9fa8d7c186191c496 | 2018-03-22T23:46:50 | canvas_modules/common-canvas/src/object-model/schemas/v2/pipeline-flow-v2-schema.json | 38 | 2024-05-29T16:37:55.377088Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"app_data_def": {
"additionalProperties": true,
"description": "Object containing app-specific data",
"properties": {
"ui_data": {
"anyOf": [
{
"$ref": "http://www.ibm.com/ibm/wdp/canvas/v2.0/pipeline-flow-ui-v2-schema.json#/definitions/pipeline_overview"
},
{
"$ref": "http://www.ibm.com/ibm/wdp/canvas/v2.0/pipeline-flow-ui-v2-schema.json#/definitions/pipeline_def"
},
{
"$ref": "http://www.ibm.com/ibm/wdp/canvas/v2.0/pipeline-flow-ui-v2-schema.json#/definitions/port_info_def"
},
{
"$ref": "http://www.ibm.com/ibm/wdp/canvas/v2.0/pipeline-flow-ui-v2-schema.json#/definitions/node_info_def"
},
{
"$ref": "http://www.ibm.com/ibm/wdp/canvas/v2.0/pipeline-flow-ui-v2-schema.json#/definitions/runtime_info_def"
}
]
}
},
"type": "object"
},
"binding_entry_node_def": {
"additionalProperties": false,
"description": "Defines an entry point (source) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://www.ibm.com/ibm/wdp/flow-v2.0/pipeline-connection-v2-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://www.ibm.com/ibm/wdp/flow-v2.0/pipeline-connection-v2-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"op": {
"description": "Binding node type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the binding node",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"binding_exit_node_def": {
"additionalProperties": false,
"description": "Defines an exit point (sink) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://www.ibm.com/ibm/wdp/flow-v2.0/pipeline-connection-v2-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://www.ibm.com/ibm/wdp/flow-v2.0/pipeline-connection-v2-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Binding node type identifier",
"type": "string"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the binding node",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"bound_port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node with optional pipeline port binding for supernodes",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"schema_ref": {
"description": "Optional data record schema associated with the port",
"type": "string"
},
"subflow_node_ref": {
"description": "Optional node id binding within the current document.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"bound_ports_def": {
"items": {
"$ref": "#/definitions/bound_port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"link_def": {
"additionalProperties": false,
"description": "Node link definition",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"node_id_ref": {
"description": "id of a node this link connects to",
"type": "string"
},
"port_id_ref": {
"description": "optional port id of a node this link connects to",
"type": "string"
}
},
"required": [
"node_id_ref"
],
"type": "object"
},
"model_node_def": {
"additionalProperties": false,
"description": "Definition of a single predictive model node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the model within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"model_ref": {
"description": "Reference to the binary model",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Reference to the runtime associated with the current node",
"type": "string"
},
"type": {
"description": "Node type - always 'model_node' for model pipeline elements",
"enum": [
"model_node"
]
}
},
"required": [
"id",
"type",
"inputs"
],
"type": "object"
},
"node_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for node within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Operator type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Optional reference to the id of the runtime associated with the current node",
"type": "string"
},
"type": {
"description": "Node type - always 'execution_node' for non-model pipeline elements",
"enum": [
"execution_node"
]
}
},
"required": [
"id",
"type",
"op"
],
"type": "object"
},
"pipeline_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline flow",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"external_parameters": {
"description": "Array of parameterized property references",
"items": {
"$ref": "http://www.ibm.com/ibm/wdp/flow-v2.0/parameters-v2-schema.json#/definitions/param_property_ref"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "User-readable name",
"type": "string"
},
"nodes": {
"description": "Array of pipeline nodes",
"items": {
"oneOf": [
{
"$ref": "#/definitions/node_def"
},
{
"$ref": "#/definitions/supernode_def"
},
{
"$ref": "#/definitions/binding_entry_node_def"
},
{
"$ref": "#/definitions/binding_exit_node_def"
},
{
"$ref": "#/definitions/model_node_def"
}
]
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"runtime_ref": {
"description": "Reference to the id of the runtime associated with the operations in the current pipeline",
"type": "string"
}
},
"required": [
"id",
"runtime_ref",
"nodes"
],
"type": "object"
},
"port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"schema_ref": {
"description": "Optional data record schema reference associated with the port",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"ports_def": {
"items": {
"$ref": "#/definitions/port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"runtime_def": {
"description": "Runtime associated with the operations in the current pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique internal runtime identifier",
"type": "string"
},
"name": {
"description": "The runtime name",
"type": "string"
},
"version": {
"description": "The runtime version. When not present the latest version is assumed",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"supernode_def": {
"additionalProperties": false,
"description": "Definition of a supernode which serves as the entry point for a sub-pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the supernode within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/bound_ports_def"
},
"outputs": {
"$ref": "#/definitions/bound_ports_def"
},
"subflow_ref": {
"description": "Refers to the sub-flow associated with this supernode",
"properties": {
"pipeline_id_ref": {
"description": "Sub-flow identifier reference",
"type": "string"
},
"url": {
"description": "Reference to an external sub-flow. When not present the sub-flow is assumed to be in the current document. A value of 'app_defined' indicates a sub-flow identifier is present, but the controlling application will serve up the sub-pipeline in the form of a new pipeline-flow document (no sub-flow is present in the document).",
"type": "string"
}
},
"required": [
"pipeline_id_ref"
],
"type": "object"
},
"type": {
"description": "Node type - always 'super_node' for supernode elements",
"enum": [
"super_node"
]
}
},
"required": [
"id",
"type",
"subflow_ref",
"inputs"
],
"type": "object"
}
},
"description": "WDP Pipeline Flow Schema",
"id": "http://www.ibm.com/ibm/wdp/flow-v2.0/pipeline-flow-v2-schema.json",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"doc_type": {
"description": "Document type",
"type": "string"
},
"id": {
"description": "Document identifier, GUID recommended",
"type": "string"
},
"json_schema": {
"description": "Refers to the JSON schema used to validate documents of this type",
"enum": [
"http://www.ibm.com/ibm/wdp/flow-v2.0/pipeline-flow-v2-schema.json"
]
},
"open_with_tool": {
"description": "Preferred authoring application",
"type": "string"
},
"pipelines": {
"description": "Array of pipelines",
"items": {
"$ref": "#/definitions/pipeline_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"primary_pipeline": {
"description": "Reference to the primary (main) pipeline flow within the document",
"type": "string"
},
"runtimes": {
"description": "Array of runtime objects referred to in the document",
"items": {
"$ref": "#/definitions/runtime_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"schemas": {
"description": "Array of data record schemas used in the document",
"items": {
"$ref": "http://www.ibm.com/ibm/wml/datarecord-metadata/v2.0/datarecord-metadata-v2-schema.json#/definitions/record_schema"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"version": {
"description": "Pipeline-flow schema version",
"enum": [
"2.0"
]
}
},
"required": [
"doc_type",
"version",
"primary_pipeline",
"pipelines"
],
"type": "object"
} | Apache-2.0 | en |
elyra-ai/canvas | 437dc6b6be10c06b4432775bb1089cfefa9aa3bf | 2018-06-05T15:57:15 | canvas_modules/common-canvas/src/object-model/schemas/v2/pipeline-flow-v2-schema.json | 38 | 2024-05-29T16:37:55.377088Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"app_data_def": {
"additionalProperties": true,
"description": "Object containing app-specific data",
"properties": {
"ui_data": {
"anyOf": [
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/pipeline_overview"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/pipeline_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/port_info_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/node_info_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/runtime_info_def"
}
]
}
},
"type": "object"
},
"binding_entry_node_def": {
"additionalProperties": false,
"description": "Defines an entry point (source) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"op": {
"description": "Binding node type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the entry binding node",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"binding_exit_node_def": {
"additionalProperties": false,
"description": "Defines an exit point (sink) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Binding node type identifier",
"type": "string"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the binding exit node",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"bound_port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node with optional pipeline port binding for supernodes",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the binding port",
"properties": {},
"type": "object"
},
"schema_ref": {
"description": "Optional data record schema associated with the port",
"type": "string"
},
"subflow_node_ref": {
"description": "Optional node id binding within the current document.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"bound_ports_def": {
"items": {
"$ref": "#/definitions/bound_port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"link_def": {
"additionalProperties": false,
"description": "Node link definition",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"node_id_ref": {
"description": "id of a node this link connects to",
"type": "string"
},
"port_id_ref": {
"description": "optional port id of a node this link connects to",
"type": "string"
}
},
"required": [
"node_id_ref"
],
"type": "object"
},
"model_node_def": {
"additionalProperties": false,
"description": "Definition of a single predictive model node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the model within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"model_ref": {
"description": "Reference to the binary model",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Reference to the runtime associated with the current node",
"type": "string"
},
"type": {
"description": "Node type - always 'model_node' for model pipeline elements",
"enum": [
"model_node"
]
}
},
"required": [
"id",
"type",
"inputs"
],
"type": "object"
},
"node_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for node within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Operator type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Optional reference to the id of the runtime associated with the current node",
"type": "string"
},
"type": {
"description": "Node type - always 'execution_node' for non-model pipeline elements",
"enum": [
"execution_node"
]
}
},
"required": [
"id",
"type",
"op"
],
"type": "object"
},
"pipeline_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline flow",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "User-readable name",
"type": "string"
},
"nodes": {
"description": "Array of pipeline nodes",
"items": {
"oneOf": [
{
"$ref": "#/definitions/node_def"
},
{
"$ref": "#/definitions/supernode_def"
},
{
"$ref": "#/definitions/binding_entry_node_def"
},
{
"$ref": "#/definitions/binding_exit_node_def"
},
{
"$ref": "#/definitions/model_node_def"
}
]
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the pipeline",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Reference to the id of the runtime associated with the operations in the current pipeline",
"type": "string"
}
},
"required": [
"id",
"runtime_ref",
"nodes"
],
"type": "object"
},
"port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the port",
"properties": {},
"type": "object"
},
"schema_ref": {
"description": "Optional data record schema reference associated with the port",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"ports_def": {
"items": {
"$ref": "#/definitions/port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"runtime_def": {
"description": "Runtime associated with the operations in the current pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique internal runtime identifier",
"type": "string"
},
"name": {
"description": "The runtime name",
"type": "string"
},
"version": {
"description": "The runtime version. When not present the latest version is assumed",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"supernode_def": {
"additionalProperties": false,
"description": "Definition of a supernode which serves as the entry point for a sub-pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the supernode within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/bound_ports_def"
},
"outputs": {
"$ref": "#/definitions/bound_ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the supernode",
"properties": {},
"type": "object"
},
"sub_type": {
"description": "Sub-flow editing type. The default is 'canvas'",
"enum": [
"canvas",
"shaper"
]
},
"subflow_ref": {
"description": "Refers to the sub-flow associated with this supernode",
"properties": {
"pipeline_id_ref": {
"description": "Sub-flow identifier reference",
"type": "string"
},
"url": {
"description": "Reference to an external sub-flow. When not present the sub-flow is assumed to be in the current document. A value of 'app_defined' indicates a sub-flow identifier is present, but the controlling application will serve up the sub-pipeline in the form of a new pipeline-flow document (no sub-flow is present in the document).",
"type": "string"
}
},
"required": [
"pipeline_id_ref"
],
"type": "object"
},
"type": {
"description": "Node type - always 'super_node' for supernode elements",
"enum": [
"super_node"
]
}
},
"required": [
"id",
"type",
"subflow_ref",
"inputs"
],
"type": "object"
}
},
"description": "WDP Pipeline Flow Schema",
"id": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-v2-schema.json",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"doc_type": {
"description": "Document type",
"type": "string"
},
"external_parameters": {
"description": "Array of parameterized property references",
"items": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/parameters/parameters-v2-schema.json#/definitions/param_property_ref"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"id": {
"description": "Document identifier, GUID recommended",
"type": "string"
},
"json_schema": {
"description": "Refers to the JSON schema used to validate documents of this type",
"enum": [
"http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-v2-schema.json"
]
},
"open_with_tool": {
"description": "Preferred authoring application",
"type": "string"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the flow document",
"properties": {},
"type": "object"
},
"pipelines": {
"description": "Array of pipelines",
"items": {
"$ref": "#/definitions/pipeline_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"primary_pipeline": {
"description": "Reference to the primary (main) pipeline flow within the document",
"type": "string"
},
"runtimes": {
"description": "Array of runtime objects referred to in the document",
"items": {
"$ref": "#/definitions/runtime_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"schemas": {
"description": "Array of data record schemas used in the document",
"items": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/datarecord-metadata/datarecord-metadata-v2-schema.json#/definitions/record_schema"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"version": {
"description": "Pipeline-flow schema version",
"enum": [
"2.0"
]
}
},
"required": [
"doc_type",
"version",
"primary_pipeline",
"pipelines"
],
"type": "object"
} | Apache-2.0 | en |
elyra-ai/canvas | b947565858845019aaaa1c6fee7d38bd33a5e171 | 2018-04-13T18:36:46 | canvas_modules/common-canvas/src/object-model/schemas/v2/pipeline-flow-v2-schema.json | 38 | 2024-05-29T16:37:55.377088Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"app_data_def": {
"additionalProperties": true,
"description": "Object containing app-specific data",
"properties": {
"ui_data": {
"anyOf": [
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/pipeline_overview"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/pipeline_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/port_info_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/node_info_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/runtime_info_def"
}
]
}
},
"type": "object"
},
"binding_entry_node_def": {
"additionalProperties": false,
"description": "Defines an entry point (source) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"op": {
"description": "Binding node type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the binding node",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"binding_exit_node_def": {
"additionalProperties": false,
"description": "Defines an exit point (sink) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Binding node type identifier",
"type": "string"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the binding node",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"bound_port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node with optional pipeline port binding for supernodes",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"schema_ref": {
"description": "Optional data record schema associated with the port",
"type": "string"
},
"subflow_node_ref": {
"description": "Optional node id binding within the current document.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"bound_ports_def": {
"items": {
"$ref": "#/definitions/bound_port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"link_def": {
"additionalProperties": false,
"description": "Node link definition",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"node_id_ref": {
"description": "id of a node this link connects to",
"type": "string"
},
"port_id_ref": {
"description": "optional port id of a node this link connects to",
"type": "string"
}
},
"required": [
"node_id_ref"
],
"type": "object"
},
"model_node_def": {
"additionalProperties": false,
"description": "Definition of a single predictive model node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the model within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"model_ref": {
"description": "Reference to the binary model",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Reference to the runtime associated with the current node",
"type": "string"
},
"type": {
"description": "Node type - always 'model_node' for model pipeline elements",
"enum": [
"model_node"
]
}
},
"required": [
"id",
"type",
"inputs"
],
"type": "object"
},
"node_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for node within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Operator type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Optional reference to the id of the runtime associated with the current node",
"type": "string"
},
"type": {
"description": "Node type - always 'execution_node' for non-model pipeline elements",
"enum": [
"execution_node"
]
}
},
"required": [
"id",
"type",
"op"
],
"type": "object"
},
"pipeline_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline flow",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "User-readable name",
"type": "string"
},
"nodes": {
"description": "Array of pipeline nodes",
"items": {
"oneOf": [
{
"$ref": "#/definitions/node_def"
},
{
"$ref": "#/definitions/supernode_def"
},
{
"$ref": "#/definitions/binding_entry_node_def"
},
{
"$ref": "#/definitions/binding_exit_node_def"
},
{
"$ref": "#/definitions/model_node_def"
}
]
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"runtime_ref": {
"description": "Reference to the id of the runtime associated with the operations in the current pipeline",
"type": "string"
}
},
"required": [
"id",
"runtime_ref",
"nodes"
],
"type": "object"
},
"port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"schema_ref": {
"description": "Optional data record schema reference associated with the port",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"ports_def": {
"items": {
"$ref": "#/definitions/port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"runtime_def": {
"description": "Runtime associated with the operations in the current pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique internal runtime identifier",
"type": "string"
},
"name": {
"description": "The runtime name",
"type": "string"
},
"version": {
"description": "The runtime version. When not present the latest version is assumed",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"supernode_def": {
"additionalProperties": false,
"description": "Definition of a supernode which serves as the entry point for a sub-pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the supernode within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/bound_ports_def"
},
"outputs": {
"$ref": "#/definitions/bound_ports_def"
},
"subflow_ref": {
"description": "Refers to the sub-flow associated with this supernode",
"properties": {
"pipeline_id_ref": {
"description": "Sub-flow identifier reference",
"type": "string"
},
"url": {
"description": "Reference to an external sub-flow. When not present the sub-flow is assumed to be in the current document. A value of 'app_defined' indicates a sub-flow identifier is present, but the controlling application will serve up the sub-pipeline in the form of a new pipeline-flow document (no sub-flow is present in the document).",
"type": "string"
}
},
"required": [
"pipeline_id_ref"
],
"type": "object"
},
"type": {
"description": "Node type - always 'super_node' for supernode elements",
"enum": [
"super_node"
]
}
},
"required": [
"id",
"type",
"subflow_ref",
"inputs"
],
"type": "object"
}
},
"description": "WDP Pipeline Flow Schema",
"id": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-v2-schema.json",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"doc_type": {
"description": "Document type",
"type": "string"
},
"external_parameters": {
"description": "Array of parameterized property references",
"items": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/parameters/parameters-v2-schema.json#/definitions/param_property_ref"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"id": {
"description": "Document identifier, GUID recommended",
"type": "string"
},
"json_schema": {
"description": "Refers to the JSON schema used to validate documents of this type",
"enum": [
"http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-v2-schema.json"
]
},
"open_with_tool": {
"description": "Preferred authoring application",
"type": "string"
},
"pipelines": {
"description": "Array of pipelines",
"items": {
"$ref": "#/definitions/pipeline_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"primary_pipeline": {
"description": "Reference to the primary (main) pipeline flow within the document",
"type": "string"
},
"runtimes": {
"description": "Array of runtime objects referred to in the document",
"items": {
"$ref": "#/definitions/runtime_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"schemas": {
"description": "Array of data record schemas used in the document",
"items": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/datarecord-metadata/datarecord-metadata-v2-schema.json#/definitions/record_schema"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"version": {
"description": "Pipeline-flow schema version",
"enum": [
"2.0"
]
}
},
"required": [
"doc_type",
"version",
"primary_pipeline",
"pipelines"
],
"type": "object"
} | Apache-2.0 | en |
elyra-ai/canvas | 0ac0e87ff80c85a46db63ae9fa8d7c186191c496 | 2018-03-22T23:46:50 | canvas_modules/common-canvas/src/object-model/schemas/v1/pipeline-flow-v1-schema.json | 38 | 2024-05-29T16:37:55.377088Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"app_data_def": {
"additionalProperties": true,
"description": "Object containing app-specific data",
"properties": {
"ui_data": {
"anyOf": [
{
"$ref": "http://www.ibm.com/ibm/wdp/canvas/v1.0/pipeline-flow-ui-schema.json#/definitions/pipeline_overview"
},
{
"$ref": "http://www.ibm.com/ibm/wdp/canvas/v1.0/pipeline-flow-ui-schema.json#/definitions/pipeline_def"
},
{
"$ref": "http://www.ibm.com/ibm/wdp/canvas/v1.0/pipeline-flow-ui-schema.json#/definitions/port_info_def"
},
{
"$ref": "http://www.ibm.com/ibm/wdp/canvas/v1.0/pipeline-flow-ui-schema.json#/definitions/node_info_def"
}
]
}
},
"type": "object"
},
"binding_entry_node_def": {
"additionalProperties": false,
"description": "Defines an entry point (source) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://www.ibm.com/ibm/wdp/flow-v1.0/pipeline-connection-v1-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://www.ibm.com/ibm/wdp/flow-v1.0/pipeline-connection-v1-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"output": {
"$ref": "#/definitions/port_binding_def"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"binding_exit_node_def": {
"additionalProperties": false,
"description": "Defines an exit point (sink) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://www.ibm.com/ibm/wdp/flow-v1.0/pipeline-connection-v1-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://www.ibm.com/ibm/wdp/flow-v1.0/pipeline-connection-v1-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding",
"type": "string"
},
"input": {
"$ref": "#/definitions/port_binding_def"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"bound_port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node with optional pipeline port binding for supernodes",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"schema_ref": {
"description": "Optional data record schema associated with the port",
"type": "string"
},
"subflow_node_ref": {
"description": "Optional node id binding within the current document.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"bound_ports_def": {
"items": {
"$ref": "#/definitions/bound_port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"link_def": {
"additionalProperties": false,
"description": "Node link definition",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"node_id_ref": {
"description": "id of a node this link connects to",
"type": "string"
},
"pipeline_id_ref": {
"description": "id of the pipeline this link connects to",
"type": "string"
},
"port_id_ref": {
"description": "optional port id of a node this link connects to",
"type": "string"
}
},
"required": [
"node_id_ref"
],
"type": "object"
},
"model_node_def": {
"additionalProperties": false,
"description": "Definition of a single predictive model node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the model within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"model_ref": {
"description": "Reference to the binary model",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'model_node' for model pipeline elements",
"enum": [
"model_node"
]
}
},
"required": [
"id",
"type",
"inputs"
],
"type": "object"
},
"node_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for node within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Operator type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'execution_node' for non-model pipeline elements",
"enum": [
"execution_node"
]
}
},
"required": [
"id",
"type",
"op"
],
"type": "object"
},
"pipeline_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline flow",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"nodes": {
"description": "Array of pipeline nodes",
"items": {
"oneOf": [
{
"$ref": "#/definitions/node_def"
},
{
"$ref": "#/definitions/supernode_def"
},
{
"$ref": "#/definitions/binding_entry_node_def"
},
{
"$ref": "#/definitions/binding_exit_node_def"
},
{
"$ref": "#/definitions/model_node_def"
}
]
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"runtime": {
"description": "Runtime associated with the operations in the current pipeline",
"type": "string"
}
},
"required": [
"id",
"runtime",
"nodes"
],
"type": "object"
},
"port_binding_def": {
"additionalProperties": false,
"description": "Definition (input/output) of a binding port on a node (bound or unbound). If no binding is present the port is bound at runtime via a configuration object or wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"link": {
"$ref": "#/definitions/link_def"
},
"schema_ref": {
"description": "Optional data record schema associated with the port",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"schema_ref": {
"description": "Optional data record schema reference associated with the port",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"ports_def": {
"items": {
"$ref": "#/definitions/port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"supernode_def": {
"additionalProperties": false,
"description": "Definition of a supernode which serves as the entry point for a sub-pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the supernode within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/bound_ports_def"
},
"outputs": {
"$ref": "#/definitions/bound_ports_def"
},
"subflow_ref": {
"description": "Refers to the sub-flow associated with this supernode",
"properties": {
"pipeline_id_ref": {
"description": "Sub-flow identifier reference",
"type": "string"
},
"url": {
"description": "Reference to an external sub-flow. When not present the sub-flow is assumed to be in the current document. A value of 'app_defined' indicates a sub-flow identifier is present, but the controlling application will serve up the sub-pipeline in the form of a new pipeline-flow document (no sub-flow is present in the document).",
"type": "string"
}
},
"required": [
"pipeline_id_ref"
],
"type": "object"
},
"type": {
"description": "Node type - always 'super_node' for supernode elements",
"enum": [
"super_node"
]
}
},
"required": [
"id",
"type",
"subflow_ref",
"inputs"
],
"type": "object"
}
},
"description": "WDP Pipeline Flow Schema",
"id": "http://www.ibm.com/ibm/wdp/flow-v1.0/pipeline-flow-v1-schema.json",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"doc_type": {
"description": "Document type",
"type": "string"
},
"id": {
"description": "Document identifier, GUID recommended",
"type": "string"
},
"json_schema": {
"description": "Refers to the JSON schema used to validate documents of this type",
"enum": [
"http://www.ibm.com/ibm/wdp/flow-v1.0/pipeline-flow-v1-schema.json"
]
},
"open_with_tool": {
"description": "Preferred authoring application",
"type": "string"
},
"pipelines": {
"description": "Array of pipelines",
"items": {
"$ref": "#/definitions/pipeline_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"primary_pipeline": {
"description": "Reference to the primary (main) pipeline flow within the document",
"type": "string"
},
"schemas": {
"description": "Array of data record schemas used in the document",
"items": {
"$ref": "http://www.ibm.com/ibm/wml/datarecord-metadata/v1.0/datarecord-metadata-v1-schema.json#/definitions/record_schema"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"version": {
"description": "Pipeline-flow schema version",
"enum": [
"1.0"
]
}
},
"required": [
"doc_type",
"version",
"primary_pipeline",
"pipelines"
],
"type": "object"
} | Apache-2.0 | en |
elyra-ai/canvas | f94a9007613d19d2d7e19926a7bcc7fce0690161 | 2021-03-09T21:57:04 | canvas_modules/common-canvas/src/object-model/schemas/v1/pipeline-flow-v1-schema.json | 38 | 2024-05-29T16:37:55.377088Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"app_data_def": {
"additionalProperties": true,
"description": "Object containing app-specific data",
"properties": {
"ui_data": {
"anyOf": [
{
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v1-schema.json#/definitions/pipeline_overview_def"
},
{
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v1-schema.json#/definitions/pipeline_def"
},
{
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v1-schema.json#/definitions/port_info_def"
},
{
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v1-schema.json#/definitions/node_info_def"
}
]
}
},
"type": "object"
},
"binding_entry_node_def": {
"additionalProperties": false,
"description": "Defines an entry point (source) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v1-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v1-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"output": {
"$ref": "#/definitions/port_binding_def"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"binding_exit_node_def": {
"additionalProperties": false,
"description": "Defines an exit point (sink) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v1-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v1-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding",
"type": "string"
},
"input": {
"$ref": "#/definitions/port_binding_def"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"bound_port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node with optional pipeline port binding for supernodes",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"schema_ref": {
"description": "Optional data record schema associated with the port",
"type": "string"
},
"subflow_node_ref": {
"description": "Optional node id binding within the current document.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"bound_ports_def": {
"items": {
"$ref": "#/definitions/bound_port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"link_def": {
"additionalProperties": false,
"description": "Node link definition",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"node_id_ref": {
"description": "id of a node this link connects to",
"type": "string"
},
"pipeline_id_ref": {
"description": "id of the pipeline this link connects to",
"type": "string"
},
"port_id_ref": {
"description": "optional port id of a node this link connects to",
"type": "string"
}
},
"required": [
"node_id_ref"
],
"type": "object"
},
"model_node_def": {
"additionalProperties": false,
"description": "Definition of a single predictive model node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the model within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"model_ref": {
"description": "Reference to the binary model",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'model_node' for model pipeline elements",
"enum": [
"model_node"
]
}
},
"required": [
"id",
"type",
"inputs"
],
"type": "object"
},
"node_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for node within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Operator type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'execution_node' for non-model pipeline elements",
"enum": [
"execution_node"
]
}
},
"required": [
"id",
"type",
"op"
],
"type": "object"
},
"pipeline_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline flow",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"nodes": {
"description": "Array of pipeline nodes",
"items": {
"oneOf": [
{
"$ref": "#/definitions/node_def"
},
{
"$ref": "#/definitions/supernode_def"
},
{
"$ref": "#/definitions/binding_entry_node_def"
},
{
"$ref": "#/definitions/binding_exit_node_def"
},
{
"$ref": "#/definitions/model_node_def"
}
]
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"runtime": {
"description": "Runtime associated with the operations in the current pipeline",
"type": "string"
}
},
"required": [
"id",
"runtime",
"nodes"
],
"type": "object"
},
"port_binding_def": {
"additionalProperties": false,
"description": "Definition (input/output) of a binding port on a node (bound or unbound). If no binding is present the port is bound at runtime via a configuration object or wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"link": {
"$ref": "#/definitions/link_def"
},
"schema_ref": {
"description": "Optional data record schema associated with the port",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"schema_ref": {
"description": "Optional data record schema reference associated with the port",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"ports_def": {
"items": {
"$ref": "#/definitions/port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"supernode_def": {
"additionalProperties": false,
"description": "Definition of a supernode which serves as the entry point for a sub-pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the supernode within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/bound_ports_def"
},
"outputs": {
"$ref": "#/definitions/bound_ports_def"
},
"subflow_ref": {
"description": "Refers to the sub-flow associated with this supernode",
"properties": {
"pipeline_id_ref": {
"description": "Sub-flow identifier reference",
"type": "string"
},
"url": {
"description": "Reference to an external sub-flow. When not present the sub-flow is assumed to be in the current document. A value of 'app_defined' indicates a sub-flow identifier is present, but the controlling application will serve up the sub-pipeline in the form of a new pipeline-flow document (no sub-flow is present in the document).",
"type": "string"
}
},
"required": [
"pipeline_id_ref"
],
"type": "object"
},
"type": {
"description": "Node type - always 'super_node' for supernode elements",
"enum": [
"super_node"
]
}
},
"required": [
"id",
"type",
"subflow_ref",
"inputs"
],
"type": "object"
}
},
"description": "WDP Pipeline Flow Schema",
"id": "https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-v1-schema.json",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"doc_type": {
"description": "Document type",
"type": "string"
},
"id": {
"description": "Document identifier, GUID recommended",
"type": "string"
},
"json_schema": {
"description": "Refers to the JSON schema used to validate documents of this type",
"enum": [
"https://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-v1-schema.json"
]
},
"open_with_tool": {
"description": "Preferred authoring application",
"type": "string"
},
"pipelines": {
"description": "Array of pipelines",
"items": {
"$ref": "#/definitions/pipeline_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"primary_pipeline": {
"description": "Reference to the primary (main) pipeline flow within the document",
"type": "string"
},
"schemas": {
"description": "Array of data record schemas used in the document",
"items": {
"$ref": "https://api.dataplatform.ibm.com/schemas/common-pipeline/datarecord-metadata/datarecord-metadata-v1-schema.json#/definitions/record_schema"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"version": {
"description": "Pipeline-flow schema version",
"enum": [
"1.0"
]
}
},
"required": [
"doc_type",
"version",
"primary_pipeline",
"pipelines"
],
"type": "object"
} | Apache-2.0 | en |
elyra-ai/canvas | f992310c6d43f2e2f5c466d65010465ae194f186 | 2018-04-23T21:23:28 | canvas_modules/common-canvas/src/object-model/schemas/v2/pipeline-flow-v2-schema.json | 38 | 2024-05-29T16:37:55.377088Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"app_data_def": {
"additionalProperties": true,
"description": "Object containing app-specific data",
"properties": {
"ui_data": {
"anyOf": [
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/pipeline_overview"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/pipeline_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/port_info_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/node_info_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/runtime_info_def"
}
]
}
},
"type": "object"
},
"binding_entry_node_def": {
"additionalProperties": false,
"description": "Defines an entry point (source) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"op": {
"description": "Binding node type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the entry binding node",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"binding_exit_node_def": {
"additionalProperties": false,
"description": "Defines an exit point (sink) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Binding node type identifier",
"type": "string"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the binding exit node",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"bound_port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node with optional pipeline port binding for supernodes",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the binding port",
"properties": {},
"type": "object"
},
"schema_ref": {
"description": "Optional data record schema associated with the port",
"type": "string"
},
"subflow_node_ref": {
"description": "Optional node id binding within the current document.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"bound_ports_def": {
"items": {
"$ref": "#/definitions/bound_port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"link_def": {
"additionalProperties": false,
"description": "Node link definition",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"node_id_ref": {
"description": "id of a node this link connects to",
"type": "string"
},
"port_id_ref": {
"description": "optional port id of a node this link connects to",
"type": "string"
}
},
"required": [
"node_id_ref"
],
"type": "object"
},
"model_node_def": {
"additionalProperties": false,
"description": "Definition of a single predictive model node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the model within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"model_ref": {
"description": "Reference to the binary model",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Reference to the runtime associated with the current node",
"type": "string"
},
"type": {
"description": "Node type - always 'model_node' for model pipeline elements",
"enum": [
"model_node"
]
}
},
"required": [
"id",
"type",
"inputs"
],
"type": "object"
},
"node_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for node within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Operator type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Optional reference to the id of the runtime associated with the current node",
"type": "string"
},
"type": {
"description": "Node type - always 'execution_node' for non-model pipeline elements",
"enum": [
"execution_node"
]
}
},
"required": [
"id",
"type",
"op"
],
"type": "object"
},
"pipeline_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline flow",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "User-readable name",
"type": "string"
},
"nodes": {
"description": "Array of pipeline nodes",
"items": {
"oneOf": [
{
"$ref": "#/definitions/node_def"
},
{
"$ref": "#/definitions/supernode_def"
},
{
"$ref": "#/definitions/binding_entry_node_def"
},
{
"$ref": "#/definitions/binding_exit_node_def"
},
{
"$ref": "#/definitions/model_node_def"
}
]
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the pipeline",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Reference to the id of the runtime associated with the operations in the current pipeline",
"type": "string"
}
},
"required": [
"id",
"runtime_ref",
"nodes"
],
"type": "object"
},
"port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the port",
"properties": {},
"type": "object"
},
"schema_ref": {
"description": "Optional data record schema reference associated with the port",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"ports_def": {
"items": {
"$ref": "#/definitions/port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"runtime_def": {
"description": "Runtime associated with the operations in the current pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique internal runtime identifier",
"type": "string"
},
"name": {
"description": "The runtime name",
"type": "string"
},
"version": {
"description": "The runtime version. When not present the latest version is assumed",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"supernode_def": {
"additionalProperties": false,
"description": "Definition of a supernode which serves as the entry point for a sub-pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the supernode within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/bound_ports_def"
},
"outputs": {
"$ref": "#/definitions/bound_ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the supernode",
"properties": {},
"type": "object"
},
"subflow_ref": {
"description": "Refers to the sub-flow associated with this supernode",
"properties": {
"pipeline_id_ref": {
"description": "Sub-flow identifier reference",
"type": "string"
},
"url": {
"description": "Reference to an external sub-flow. When not present the sub-flow is assumed to be in the current document. A value of 'app_defined' indicates a sub-flow identifier is present, but the controlling application will serve up the sub-pipeline in the form of a new pipeline-flow document (no sub-flow is present in the document).",
"type": "string"
}
},
"required": [
"pipeline_id_ref"
],
"type": "object"
},
"type": {
"description": "Node type - always 'super_node' for supernode elements",
"enum": [
"super_node"
]
}
},
"required": [
"id",
"type",
"subflow_ref",
"inputs"
],
"type": "object"
}
},
"description": "WDP Pipeline Flow Schema",
"id": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-v2-schema.json",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"doc_type": {
"description": "Document type",
"type": "string"
},
"external_parameters": {
"description": "Array of parameterized property references",
"items": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/parameters/parameters-v2-schema.json#/definitions/param_property_ref"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"id": {
"description": "Document identifier, GUID recommended",
"type": "string"
},
"json_schema": {
"description": "Refers to the JSON schema used to validate documents of this type",
"enum": [
"http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-v2-schema.json"
]
},
"open_with_tool": {
"description": "Preferred authoring application",
"type": "string"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the flow document",
"properties": {},
"type": "object"
},
"pipelines": {
"description": "Array of pipelines",
"items": {
"$ref": "#/definitions/pipeline_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"primary_pipeline": {
"description": "Reference to the primary (main) pipeline flow within the document",
"type": "string"
},
"runtimes": {
"description": "Array of runtime objects referred to in the document",
"items": {
"$ref": "#/definitions/runtime_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"schemas": {
"description": "Array of data record schemas used in the document",
"items": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/datarecord-metadata/datarecord-metadata-v2-schema.json#/definitions/record_schema"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"version": {
"description": "Pipeline-flow schema version",
"enum": [
"2.0"
]
}
},
"required": [
"doc_type",
"version",
"primary_pipeline",
"pipelines"
],
"type": "object"
} | Apache-2.0 | en |
elyra-ai/canvas | 2c28a173d86c7984a6fc8b6fe71d4805a048dd80 | 2018-10-24T22:35:46 | canvas_modules/common-canvas/src/object-model/schemas/v2/pipeline-flow-v2-schema.json | 38 | 2024-05-29T16:37:55.377088Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"app_data_def": {
"additionalProperties": true,
"description": "Object containing app-specific data",
"properties": {
"ui_data": {
"anyOf": [
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/pipeline_overview_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/pipeline_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/port_info_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/node_info_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/runtime_info_def"
}
]
}
},
"type": "object"
},
"binding_entry_node_def": {
"additionalProperties": false,
"description": "Defines an entry point (source) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"op": {
"description": "Binding node type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the entry binding node",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"binding_exit_node_def": {
"additionalProperties": false,
"description": "Defines an exit point (sink) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Binding node type identifier",
"type": "string"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the binding exit node",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"bound_port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node with optional pipeline port binding for supernodes",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the binding port",
"properties": {},
"type": "object"
},
"schema_ref": {
"description": "Optional data record schema associated with the port",
"type": "string"
},
"subflow_node_ref": {
"description": "Optional node id binding within the current document.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"bound_ports_def": {
"items": {
"$ref": "#/definitions/bound_port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"link_def": {
"additionalProperties": false,
"description": "Node link definition",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"link_name": {
"description": "optional link name (used in parameter sets when there are multiple input sources)",
"type": "string"
},
"node_id_ref": {
"description": "id of a node this link connects to",
"type": "string"
},
"port_id_ref": {
"description": "optional port id of a node this link connects to",
"type": "string"
}
},
"required": [
"node_id_ref"
],
"type": "object"
},
"model_node_def": {
"additionalProperties": false,
"description": "Definition of a single predictive model node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the model within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"model_ref": {
"description": "Reference to the binary model",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Reference to the runtime associated with the current node",
"type": "string"
},
"type": {
"description": "Node type - always 'model_node' for model pipeline elements",
"enum": [
"model_node"
]
}
},
"required": [
"id",
"type",
"inputs"
],
"type": "object"
},
"node_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for node within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Operator type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Optional reference to the id of the runtime associated with the current node",
"type": "string"
},
"type": {
"description": "Node type - always 'execution_node' for non-model pipeline elements",
"enum": [
"execution_node"
]
}
},
"required": [
"id",
"type",
"op"
],
"type": "object"
},
"pipeline_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline flow",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "User-readable name",
"type": "string"
},
"nodes": {
"description": "Array of pipeline nodes",
"items": {
"oneOf": [
{
"$ref": "#/definitions/node_def"
},
{
"$ref": "#/definitions/supernode_def"
},
{
"$ref": "#/definitions/binding_entry_node_def"
},
{
"$ref": "#/definitions/binding_exit_node_def"
},
{
"$ref": "#/definitions/model_node_def"
}
]
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the pipeline",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Reference to the id of the runtime associated with the operations in the current pipeline",
"type": "string"
}
},
"required": [
"id",
"runtime_ref",
"nodes"
],
"type": "object"
},
"port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the port",
"properties": {},
"type": "object"
},
"schema_ref": {
"description": "Optional data record schema reference associated with the port",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"ports_def": {
"items": {
"$ref": "#/definitions/port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"runtime_def": {
"description": "Runtime associated with the operations in the current pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique internal runtime identifier",
"type": "string"
},
"name": {
"description": "The runtime name",
"type": "string"
},
"version": {
"description": "The runtime version. When not present the latest version is assumed",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"supernode_def": {
"additionalProperties": false,
"description": "Definition of a supernode which serves as the entry point for a sub-pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the supernode within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/bound_ports_def"
},
"open_with_tool": {
"description": "Name of the tool which can be used to view or edit the sub-flow for this supernode. The default is 'canvas'",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/bound_ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the supernode",
"properties": {},
"type": "object"
},
"subflow_ref": {
"description": "Refers to the sub-flow associated with this supernode",
"properties": {
"pipeline_id_ref": {
"description": "Sub-flow identifier reference",
"type": "string"
},
"url": {
"description": "Reference to an external sub-flow. When not present the sub-flow is assumed to be in the current document. A value of 'app_defined' indicates a sub-flow identifier is present, but the controlling application will serve up the sub-pipeline in the form of a new pipeline-flow document (no sub-flow is present in the document).",
"type": "string"
}
},
"required": [
"pipeline_id_ref"
],
"type": "object"
},
"type": {
"description": "Node type - always 'super_node' for supernode elements",
"enum": [
"super_node"
]
}
},
"required": [
"id",
"type",
"subflow_ref",
"inputs"
],
"type": "object"
}
},
"description": "WDP Pipeline Flow Schema",
"id": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-v2-schema.json",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"doc_type": {
"description": "Document type",
"type": "string"
},
"external_parameters": {
"description": "Array of parameterized property references",
"items": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/parameters/parameters-v2-schema.json#/definitions/param_property_ref"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"id": {
"description": "Document identifier, GUID recommended",
"type": "string"
},
"json_schema": {
"description": "Refers to the JSON schema used to validate documents of this type",
"enum": [
"http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-v2-schema.json"
]
},
"open_with_tool": {
"description": "Preferred authoring application",
"type": "string"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the flow document",
"properties": {},
"type": "object"
},
"pipelines": {
"description": "Array of pipelines",
"items": {
"$ref": "#/definitions/pipeline_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"primary_pipeline": {
"description": "Reference to the primary (main) pipeline flow within the document",
"type": "string"
},
"runtimes": {
"description": "Array of runtime objects referred to in the document",
"items": {
"$ref": "#/definitions/runtime_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"schemas": {
"description": "Array of data record schemas used in the document",
"items": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/datarecord-metadata/datarecord-metadata-v2-schema.json#/definitions/record_schema"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"version": {
"description": "Pipeline-flow schema version",
"enum": [
"2.0"
]
}
},
"required": [
"doc_type",
"version",
"primary_pipeline",
"pipelines"
],
"type": "object"
} | Apache-2.0 | en |
elyra-ai/canvas | 233382d15284ca92e483e27b6faa7d324ad6db9d | 2018-06-08T23:44:02 | canvas_modules/common-canvas/src/object-model/schemas/v2/pipeline-flow-v2-schema.json | 38 | 2024-05-29T16:37:55.377088Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"definitions": {
"app_data_def": {
"additionalProperties": true,
"description": "Object containing app-specific data",
"properties": {
"ui_data": {
"anyOf": [
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/pipeline_overview"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/pipeline_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/port_info_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/node_info_def"
},
{
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-ui-v2-schema.json#/definitions/runtime_info_def"
}
]
}
},
"type": "object"
},
"binding_entry_node_def": {
"additionalProperties": false,
"description": "Defines an entry point (source) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"op": {
"description": "Binding node type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the entry binding node",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"binding_exit_node_def": {
"additionalProperties": false,
"description": "Defines an exit point (sink) for a pipeline. Bindings can be concrete: the concrete_binding element is present on the port; or bindings can be abstract: bindings are performed externally via configuration or a wrapper document.",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"connection": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_connection_def"
},
"data_asset": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-connection/pipeline-connection-v2-schema.json#/definitions/common_pipeline_data_asset_def"
},
"id": {
"description": "Unique identifier for the binding within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Binding node type identifier",
"type": "string"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the binding exit node",
"properties": {},
"type": "object"
},
"type": {
"description": "Node type - always 'binding' for binding elements",
"enum": [
"binding"
]
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"bound_port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node with optional pipeline port binding for supernodes",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the binding port",
"properties": {},
"type": "object"
},
"schema_ref": {
"description": "Optional data record schema associated with the port",
"type": "string"
},
"subflow_node_ref": {
"description": "Optional node id binding within the current document.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"bound_ports_def": {
"items": {
"$ref": "#/definitions/bound_port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"link_def": {
"additionalProperties": false,
"description": "Node link definition",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"link_name": {
"description": "optional link name (used in parameter sets when there are multiple input sources)",
"type": "string"
},
"node_id_ref": {
"description": "id of a node this link connects to",
"type": "string"
},
"port_id_ref": {
"description": "optional port id of a node this link connects to",
"type": "string"
}
},
"required": [
"node_id_ref"
],
"type": "object"
},
"model_node_def": {
"additionalProperties": false,
"description": "Definition of a single predictive model node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the model within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"model_ref": {
"description": "Reference to the binary model",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Reference to the runtime associated with the current node",
"type": "string"
},
"type": {
"description": "Node type - always 'model_node' for model pipeline elements",
"enum": [
"model_node"
]
}
},
"required": [
"id",
"type",
"inputs"
],
"type": "object"
},
"node_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for node within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/ports_def"
},
"op": {
"description": "Operator type identifier",
"type": "string"
},
"outputs": {
"$ref": "#/definitions/ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the operator",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Optional reference to the id of the runtime associated with the current node",
"type": "string"
},
"type": {
"description": "Node type - always 'execution_node' for non-model pipeline elements",
"enum": [
"execution_node"
]
}
},
"required": [
"id",
"type",
"op"
],
"type": "object"
},
"pipeline_def": {
"additionalProperties": false,
"description": "Definition of a single pipeline flow",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "User-readable name",
"type": "string"
},
"nodes": {
"description": "Array of pipeline nodes",
"items": {
"oneOf": [
{
"$ref": "#/definitions/node_def"
},
{
"$ref": "#/definitions/supernode_def"
},
{
"$ref": "#/definitions/binding_entry_node_def"
},
{
"$ref": "#/definitions/binding_exit_node_def"
},
{
"$ref": "#/definitions/model_node_def"
}
]
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the pipeline",
"properties": {},
"type": "object"
},
"runtime_ref": {
"description": "Reference to the id of the runtime associated with the operations in the current pipeline",
"type": "string"
}
},
"required": [
"id",
"runtime_ref",
"nodes"
],
"type": "object"
},
"port_def": {
"additionalProperties": false,
"description": "Port definition (input/output) on a node",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier",
"type": "string"
},
"links": {
"description": "Array of links going into the node. Applies to input ports and exit bindings only.",
"items": {
"$ref": "#/definitions/link_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the port",
"properties": {},
"type": "object"
},
"schema_ref": {
"description": "Optional data record schema reference associated with the port",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"ports_def": {
"items": {
"$ref": "#/definitions/port_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"runtime_def": {
"description": "Runtime associated with the operations in the current pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique internal runtime identifier",
"type": "string"
},
"name": {
"description": "The runtime name",
"type": "string"
},
"version": {
"description": "The runtime version. When not present the latest version is assumed",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"supernode_def": {
"additionalProperties": false,
"description": "Definition of a supernode which serves as the entry point for a sub-pipeline",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"id": {
"description": "Unique identifier for the supernode within the current pipeline",
"type": "string"
},
"inputs": {
"$ref": "#/definitions/bound_ports_def"
},
"outputs": {
"$ref": "#/definitions/bound_ports_def"
},
"parameters": {
"additionalProperties": true,
"description": "Input parameters for the supernode",
"properties": {},
"type": "object"
},
"sub_type": {
"description": "Sub-flow editing type. The default is 'canvas'",
"enum": [
"canvas",
"shaper"
]
},
"subflow_ref": {
"description": "Refers to the sub-flow associated with this supernode",
"properties": {
"pipeline_id_ref": {
"description": "Sub-flow identifier reference",
"type": "string"
},
"url": {
"description": "Reference to an external sub-flow. When not present the sub-flow is assumed to be in the current document. A value of 'app_defined' indicates a sub-flow identifier is present, but the controlling application will serve up the sub-pipeline in the form of a new pipeline-flow document (no sub-flow is present in the document).",
"type": "string"
}
},
"required": [
"pipeline_id_ref"
],
"type": "object"
},
"type": {
"description": "Node type - always 'super_node' for supernode elements",
"enum": [
"super_node"
]
}
},
"required": [
"id",
"type",
"subflow_ref",
"inputs"
],
"type": "object"
}
},
"description": "WDP Pipeline Flow Schema",
"id": "http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-v2-schema.json",
"properties": {
"app_data": {
"$ref": "#/definitions/app_data_def"
},
"doc_type": {
"description": "Document type",
"type": "string"
},
"external_parameters": {
"description": "Array of parameterized property references",
"items": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/parameters/parameters-v2-schema.json#/definitions/param_property_ref"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"id": {
"description": "Document identifier, GUID recommended",
"type": "string"
},
"json_schema": {
"description": "Refers to the JSON schema used to validate documents of this type",
"enum": [
"http://api.dataplatform.ibm.com/schemas/common-pipeline/pipeline-flow/pipeline-flow-v2-schema.json"
]
},
"open_with_tool": {
"description": "Preferred authoring application",
"type": "string"
},
"parameters": {
"additionalProperties": true,
"description": "Parameters for the flow document",
"properties": {},
"type": "object"
},
"pipelines": {
"description": "Array of pipelines",
"items": {
"$ref": "#/definitions/pipeline_def"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"primary_pipeline": {
"description": "Reference to the primary (main) pipeline flow within the document",
"type": "string"
},
"runtimes": {
"description": "Array of runtime objects referred to in the document",
"items": {
"$ref": "#/definitions/runtime_def"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"schemas": {
"description": "Array of data record schemas used in the document",
"items": {
"$ref": "http://api.dataplatform.ibm.com/schemas/common-pipeline/datarecord-metadata/datarecord-metadata-v2-schema.json#/definitions/record_schema"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"version": {
"description": "Pipeline-flow schema version",
"enum": [
"2.0"
]
}
},
"required": [
"doc_type",
"version",
"primary_pipeline",
"pipelines"
],
"type": "object"
} | Apache-2.0 | en |
Subsets and Splits