configschema.json

{
    "$schema": "http://json-schema.org/schema#",
    "$id": "http://github.com/tapis-project/tapisflask/schemas/configschema.json",
    "type": "object",
    "additionalProperties": true,
    "required":[
      "service_name",
      "version",
      "log_level",
      "rabbitmq_uri",
      "global_tenant_object",
      "global_site_object",
      "spawner_host_id",
      "nfs_base_path"
    ],
    "properties": {
      "python_framework_type": {
        "type": "string",
        "default": "fastapi",
        "description": "The framework this service will use. e.g. Flask, Django, FastApi, etc."
      },
      "kubernetes_namespace": {
        "type": "string",
        "description": "The namespace to find traefik config and pods. Relevant to health so that it can modify config in realtime."
      },
      "kubernetes_deploy_namespace": {
        "type": "string",
        "description": "The namespace for kubernetes to create workers and pods in. Only relevant to spawner and health."
      },
      "rabbitmq_uri": {
        "type": "string",
        "description": "URI for rabbitMQ."
      },
      "pvc_storage_class_name": {
        "type": "string",
        "description": "Which kubernetes storage class to use when creating default persistent volume claims."
      },
      "default_pod_cpu_limit": {
        "type": "integer",
        "description": "Default CPU allocation pod is allowed to use. In millicpus (m). 1000 = 1 cpu.",
        "default": 2000
      },
      "default_pod_cpu_request": {
        "type": "integer",
        "description": "Default CPU allocation pod requests at startup. In millicpus (m). 1000 = 1 cpu.",
        "default": 250
      },
      "maximum_pod_cpu_val":{
        "type": "integer",
        "description": "Maximum CPU allocation pod is allowed to have as limit or request. In millicpus (m). 1000 = 1 cpu.",
        "default": 6000
      },
      "minimum_pod_cpu_val":{
        "type": "integer",
        "description": "Minimum CPU allocation pod is allowed to have as limit or request. In millicpus (m). 1000 = 1 cpu.",
        "default": 250
      },
      "default_pod_mem_limit": {
        "type": "integer",
        "description": "Default memory allocation pod is allowed to use. In megabytes (Mi).",
        "default": 3072
      },
      "default_pod_mem_request": {
        "type": "integer",
        "description": "Default memory allocation pod requests at startup. In megabytes (Mi)",
        "default": 256
      },
      "maximum_pod_mem_val":{
        "type": "integer",
        "description": "Maximum memory allocation pod is allowed to have as limit or request. In megabytes (Mi)",
        "default": 12288
      },
      "minimum_pod_mem_val":{
        "type": "integer",
        "description": "Minimum memory allocation pod is allowed to have as limit or request. In megabytes (Mi)",
        "default": 256
      },
      "maximum_pod_gpu_val":{
        "type": "integer",
        "description": "Maximum GPU allocation pod is allowed to have in resources.gpus.",
        "default": 1
      },
      "postgres_engine_echo_for_debug": {
        "type": "boolean",
        "description": "Whether or not to echo postgres engine queries for debugging.",
        "default": false
      },
      "compute_queues": {
        "type": "array",
        "description": "List of node objects available to the spawner using this config.",
        "required": ["queue_name"],
        "additionalProperties": false,
        "items": {
          "type": "object",
          "properties": {
            "queue_name": {
              "type": "string",
              "description": "Name of the queue being made available."
            },
            "default": {
              "type": "boolean",
              "description": "Whether or not this is the default queue to use."
            },
            "node_selector": {
              "type": "string",
              "description": "Kubernetes spec.nodeSelector required to access node. [A-z][0-9]-_ comma seperated. e.g. 'gpu,v100', 'region,us-west', 'name_id,my_node_id'"
            },
            "description": {
              "type": "string",
              "description": "Description to be displayed in the UI."
            },
            "cpu_info": {
              "type": "string",
              "description": "CPU information of the node. e.g. 'Intel(R) Xeon(R) CPU E5-2686 v4 @ 2.30GHz'",
              "default": "Unknown - Not defined in config.yml"
            },
            "cpu_architecture": {
              "type": "string",
              "description": "Architecture of the node. e.g. 'x86_64' or 'arm64'",
              "default": "Unknown - Not defined in config.yml"
            },
            "max_memory": {
              "type": "integer",
              "description": "Maximum memory (RAM) allowed for this queue in GB."
            },
            "default_memory_limit": {
              "type": "integer",
              "description": "Default memory (RAM) limit for this queue in GB."
            },
            "default_memory_request": {
              "type": "integer",
              "description": "Default memory (RAM) request for this queue in GB."
            },
            "min_memory": {
              "type": "integer",
              "description": "Minimum memory (RAM) allowed for this queue in GB.",
              "default": 256
            },
            "max_cpus": {
              "type": "integer",
              "description": "Maximum CPU value allowed for this queue."
            },
            "default_cpu_limit": {
              "type": "integer",
              "description": "Default CPU limit for pods on this queue."
            },
            "default_cpu_request": {
              "type": "integer",
              "description": "Default CPU request for pods on this queue."
            },
            "min_cpus": {
              "type": "integer",
              "description": "Minimum CPU value allowed for this queue.",
              "default": 250
            },
            "tolerations": {
              "type": "array",
              "description": "Kubernetes spec.tolerations required to tolerate the node.",
              "required": ["key"],
              "additionalProperties": false,
              "items": {
                "type": "object",
                "properties": {
                  "key": {
                    "type": "string",
                    "description": "Key of the toleration."
                  },
                  "operator": {
                    "type": "string",
                    "description": "Operator of the toleration."
                  },
                  "value": {
                    "type": "string",
                    "description": "Value of the toleration."
                  },
                  "effect": {
                    "type": "string",
                    "description": "Effect of the toleration."
                  }
                }
              }
            },
            "gpu_resources": {
              "type": "array",
              "description": "List of GPU resources available to the spawner using this config.",
              "required": ["device_name", "activation_resource"],
              "additionalProperties": false,
              "items": {
                "type": "object",
                "properties": {
                  "gpu_name": {
                    "type": "string",
                    "description": "Colloquial name for the GPU device. e.g. 'NVIDIA Tesla V100-SXM2-16GB' or 'NVIDIA Tesla T4'"
                  },
                  "description": {
                    "type": "string",
                    "description": "Description to be displayed in the UI for the device."
                  },
                  "brand": {
                    "type": "string",
                    "description": "Brand of the GPU device. e.g. 'NVIDIA' or 'AMD'"
                  },
                  "vram": {
                    "type": "integer",
                    "description": "Amount of VRAM on the device in GB."
                  },
                  "activation_resource": {
                    "type": "string",
                    "description": "Activation resource for the GPU device. What you put in K8 'spec.containers[X].resources.requests' to activate this GPU. e.g. 'nvidia.com/gpu' or 'nvidia.com/gpu.shared"
                  },
                  "default_gpu_request": {
                    "type": "integer",
                    "description": "Default int a user can request for this device.",
                    "default": 1
                  },
                  "max_gpu_request": {
                    "type": "integer",
                    "description": "Maximum gpus a user can request for this device. Time-sliced GPUs should say 1 unless they work different, if so, contact admin.",
                    "default": 1
                  }
                }
              }
            }
          }
        }
      },
      "spawner_host_id": {
        "type": "integer",
        "description": "Unique host_id for worker host. Each host should have at least one spawner and health check worker."
      },
      "test_abaco_service_password": {
        "type": "string",
        "description": "Abaco service password is required to run tests as it's able to generate tokens."
      },
      "image_allow_list": {
        "type": "array",
        "description": "Docker images that users are allowed to use.",
        "items": {
          "type": "string"
        }
      },
      "nfs_base_path": {
        "type": "string",
        "description": "Base path for nfs system root_dir. Should be /{base_path}/{tenant}/, tenant is added at runtime."
      },
      "global_tenant_object": {
        "type": "object",
        "description": "Object containing global parameters which tenants may overwrite at times.",
        "additionalProperties": false,
        "properties": {
          "log_ex": {
            "type": "integer",
            "description": "Default amount of time, in seconds, before a log is deleted from Mongo DB.",
            "default": 43200
          },
          "log_ex_limit": {
            "type": "integer",
            "description": "Ceiling for custom log_ex able to be set for a tenant."
          },
          "web_max_log_length": {
            "type": "integer",
            "description": "Max length (bytes) to store an actors exec's logs. Truncated otherwise. Cannot exceed max mongo doc len.",
            "default":1000000
          },    
          "use_tas_uid": {
            "type": "boolean",
            "description": "Whether or not to use tas for authentication.",
            "default": false
          },
          "actor_uid": {
            "type": "integer",
            "description": "If using uid and gid, what uid globally should be set as."
          },
          "actor_gid": {
            "type": "integer",
            "description": "If using uid and gid, what gid globally should be set as."
          },
          "default_token": {
            "type": "boolean",
            "description": "Default value for an actor's token attribute. Set globally.",
            "default": false
          },
          "generate_clients": {
            "type": "boolean",
            "description": "Whether or not to generate clients when creating workers.",
            "default": false
          },
          "actor_homedir":{
            "type":"string",
            "description": "Allows for specification regarding an actors homedir to use."
          },
          "global_mounts": {
            "type": "array",
            "description": "Global mounts.",
            "items": {
              "type": "string"
            }
          }
        },
        "oneOf": [
          {
            "properties": {
              "use_tas_uid": {
                "type": "boolean",
                "enum": [
                  true
                ]
              }
            },
            "required": [
              "use_tas_uid",
              "log_ex",
              "log_ex_limit"
            ]
          },
          {
            "required": [
              "actor_uid",
              "actor_gid",
              "log_ex",
              "log_ex_limit"
            ]
          },
          {
            "properties": {
              "use_tas_uid": {
                "type": "boolean",
                "enum": [
                  false,
                  null
                ]
              },
              "actor_gid": {
                "type":"integer",
                "enum": [
                  null
                ]
              },
              "actor_uid": {
                "type":"integer",
                "enum": [
                  null
                ]
              }
            },
            "required": [
              "log_ex",
              "log_ex_limit"
            ]
          }
        ]
      }
    },
    "patternProperties": {
      "^.*_tenant_object": {
        "type": "object",
        "description": "Object containing tenant based properties.",
        "additionalProperties": false,
        "properties": {
          "log_ex": {
            "type": "integer",
            "description": "Default amount of time, in seconds, before a log is deleted from Mongo DB."
          },
          "log_ex_limit": {
            "type": "integer",
            "description": "Ceiling for custom log_ex able to be set for a tenant."
          },
          "use_tas_uid": {
            "type": "boolean",
            "description": "Whether or not to use tas for authentication for tenant."
          },
          "actor_uid": {
            "type": "integer",
            "description": "If using uid and gid, what uid by tenant should be set as."
          },
          "actor_gid": {
            "type": "integer",
            "description": "If using uid and gid, what gid by tenant should be set as."
          },
          "default_token": {
            "type": "boolean",
            "description": "Default value for an actor's token attribute. Set per tenant."
          },
          "generate_clients": {
            "type": "boolean",
            "description": "Whether or not to generate clients when creating workers for this tenant."
          },
          "actor_homedir":{
            "type":"string",
            "description": "Allows for specification regarding an actors homedir to use for this tenant."
          },
          "global_mounts": {
            "type": "array",
            "description": "Global mounts for this tenant.",
            "items": {
              "type": "string"
            }
          }
        },
        "oneOf": [
          {
            "properties": {
              "use_tas_uid": {
                "type":"boolean",
                "enum": [
                  true
                ]
              }
            },
            "required": [
              "use_tas_uid",
              "log_ex",
              "log_ex_limit"
            ]
          },
          {
            "required": [
              "actor_uid",
              "actor_gid",
              "log_ex",
              "log_ex_limit"
            ]
          },
          {
            "properties": {
              "use_tas_uid": {
                "type":"boolean",
                "enum": [
                  false,
                  null
                ]
              },
              "actor_gid": {
                "type":"integer",
                "enum": [
                  null
                ]
              },
              "actor_uid": {
                "type":"integer",
                "enum": [
                  null
                ]
              }
            },
            "required": [
              "log_ex",
              "log_ex_limit"  
            ]
          }
        ]
      }
    }
  }