values.schema.json

{
    "$schema": "http://json-schema.org/schema#",
    "type": "object",
    "properties": {
        "service": {
            "description": "spark-history specific configuration",
            "type": "object",
            "properties": {
                "sparkui": {
                    "description": "enable",
                    "type": "boolean",
                    "default": false
                  }
            }
        },
        "resources": {
            "description": "Your service will have at least the requested resources and never more than its limits. No limit for a resource and you can consume everything left on the host machine.",
            "type": "object",
            "properties": {
                "requests": {
                    "description": "Guaranteed resources",
                    "type": "object",
                    "properties": {
                      "cpu": {
                        "description": "The amount of cpu guaranteed",
                        "type": "string",
                        "default": "0.1"
                      },
                      "memory": {
                        "description": "The amount of cpu guaranteed",
                        "type": "string",
                        "default": "512Mi"
                      }
                    }
                }
            }
        },
        "persistence": {
            "description": "Configuration for persistence",
            "type": "object",
            "properties": {
                "enabled": {
                    "type": "boolean",
                    "description": "Create a persistent volume",
                    "default": true
                },
                "size": {
                    "type": "string",
                    "description": "Size of the persistent volume",
                    "default": "10Gi"
                }
            }
        },
        "security": {
            "description": "security specific configuration",
            "type": "object",
            "properties": {
                "password": {
                    "type": "string",
                    "description": "Password",
                    "default": "changeme",
                    "x-form": {
                        "value": "{{user.password}}"
                    }
                },
                "whitelist": {
                    "type": "object",
                    "description": "IP protection",
                    "properties": {
                      "enable": {
                        "type": "boolean",
                        "title": "Enable IP protection",
                        "description": "Only the configured set of IPs will be able to reach the service",
                        "default": true
                      },
                      "ip": {
                        "type": "string",
                        "description": "the white list of IP is whitespace",
                        "title": "Whitelist of IP",
                        "x-form": {
                          "value": "{{user.ip}}"
                        }
                      }
                    }
                },
                "networkPolicy": {
                    "type": "object",
                    "description": "Define access policy to the service",
                    "properties": {
                      "enable": {
                        "type": "boolean",
                        "title": "Enable network policy",
                        "description": "Only pod from the same namespace will be allowed",
                        "default": true
                      }
                    }
                }
            }
        },
        "environment": {
            "description": "configuration of your environment variables",
            "type": "object",
            "properties": {
                "s3": {
                    "type": "boolean",
                    "description": "Add S3 temporary identity inside your environment",
                    "default": true
                },
                "vault": {
                    "type": "boolean",
                    "description": "Add vault temporary identity inside your environment",
                    "default": true
                },
                "git": {
                    "type": "boolean",
                    "description": "Add git config inside your environment",
                    "default": true
                }
            }
        },
        "kubernetes": {
          "description": "configuration of your kubernetes access",
          "type": "object",
          "properties": {
            "enable": {
              "type": "boolean",
              "description": "allow your service to access your namespace ressources",
              "default": true
            },
            "role": {
              "type": "string",
              "description": "bind your service account to this kubernetes default role",
              "default": "view",
              "enum": [
                "view",
                "edit",
                "admin"
              ]
            }
          }
        },
        "git": {
            "description": "Git user configuration",
            "type": "object",
            "properties": {
                "name": {
                    "type": "string",
                    "description": "user name for git",
                    "default": "",
                    "x-form": {
                        "value": "{{git.name}}",
                        "readonly": true
                    }
                },
                "email": {
                    "type": "string",
                    "description": "user email for git",
                    "default": "",
                    "x-form": {
                        "value": "{{git.email}}",
                        "readonly": true
                    }
                },
                "cache": {
                    "type": "string",
                    "description": "duration in seconds of the credentials cache duration",
                    "default": "",
                    "x-form": {
                        "value": "{{git.credentials_cache_duration}}",
                        "readonly": false
                    }
                }
            }
        },
        "vault": {
            "description": "Configuration of vault client",
            "type": "object",
            "properties": {
                "token": {
                    "description": "token vault",
                    "type": "string",
                    "x-form": {
                        "value": "{{vault.VAULT_TOKEN}}"
                    }
                },
                "url": {
                    "description": "url of vault server",
                    "type": "string",
                    "x-form": {
                        "value": "{{vault.VAULT_ADDR}}"
                    }
                },
                "mount": {
                    "description": "mount of the v2 secret engine",
                    "type": "string",
                    "x-form": {
                        "value": "{{vault.VAULT_MOUNT}}"
                    }
                },
                "directory": {
                    "description": "top level directory",
                    "type": "string",
                    "x-form": {
                        "value": "{{vault.VAULT_TOP_DIR}}"
                    }
                },
                "secret": {
                    "description": "the path of the secret to convert into a list of environment variables",
                    "type": "string",
                    "default": ""
                }
            }
        },
        "s3": {
            "description": "Configuration of temporary identity",
            "type": "object",
            "properties": {
                "accessKeyId": {
                    "description": "AWS Access Key",
                    "type": "string",
                    "x-form": {
                        "value": "{{s3.AWS_ACCESS_KEY_ID}}",
                        "hidden": true
                    }
                },
                "endpoint": {
                    "description": "AWS S3 Endpoint",
                    "type": "string",
                    "x-form": {
                        "value": "{{s3.AWS_S3_ENDPOINT}}",
                        "hidden": true
                    }
                },
                "defaultRegion": {
                    "description": "AWS S3 default region",
                    "type": "string",
                    "x-form": {
                        "value": "{{s3.AWS_DEFAULT_REGION}}",
                        "hidden": true
                    }
                },
                "secretAccessKey": {
                    "description": "AWS S3 secret access key",
                    "type": "string",
                    "x-form": {
                        "value": "{{s3.AWS_SECRET_ACCESS_KEY}}",
                        "hidden": true
                    }
                },
                "sessionToken": {
                    "description": "AWS S3 session Token",
                    "type": "string",
                    "x-form": {
                        "value": "{{s3.AWS_SESSION_TOKEN}}",
                        "hidden": true
                    }
                }
            }
        },
        "ingress": {
            "type": "object",
            "form": true,
            "title": "Ingress Details",
            "properties": {
                "hostname": {
                    "type": "string",
                    "form": true,
                    "title": "Hostname",
                    "x-form": {
                        "hidden": true
                    },
                    "x-generated": {
                        "type": "externalDNS",
                        "scope": "jupyter",
                        "name": "uijupyter"
                    }
                },
                "sparkHostname": {
                    "type": "string",
                    "form": true,
                    "title": "Hostname",
                    "x-form": {
                        "hidden": true
                    },
                    "x-generated": {
                        "type": "externalDNS",
                        "scope": "jupyter",
                        "name": "sparkui"
                    }
                }
            }
        },
        "init": {
            "description": "Init parameters",
            "type": "object",
            "properties": {
                "standardInit": {
                    "type": "string",
                    "description": "initialization script",
                    "default": "",
                    "x-form": {
                        "hidden": true
                    },
                    "x-generated": {
                        "type": "initScript",
                        "scope": "jupyter"
                    }
                },
                "personnalInit": {
                    "type": "string",
                    "description": "initialization script",
                    "default": ""
                }
            }
        }
    }
}