ob-metaflow-extensions 1.1.175rc1__py2.py3-none-any.whl → 1.1.175rc3__py2.py3-none-any.whl

metaflow_extensions/outerbounds/plugins/apps/core/config_schema_autogen.json

@@ -1,336 +0,0 @@
-{
-  "title": "Outerbounds App Configuration Schema",
-  "description": "Schema for defining Outerbounds Apps configuration. This schema is what we will end up using on the CLI/programmatic interface.\nHow to read this schema:\n  1. If the a property has `allow_union`:true then it will allow overrides from the cli.\n  2. If a property has `experimental` set to true then a lot its validations may-be skipped and parsing handled somewhere else.\n\nThe YAML based schema file is for Humans to change and consume. The JSON based schema file is what gets autogenerated based on pre-commit\nhooks so that we can use within the outerbounds package. The reasons for two distinct types of files it that YAML provides the ability to\nadd comments and make readability easier. While JSON is so that we can reduce the dependency on YAML when working with apps within both\nMetaflow and OB package.\n",
-  "version": "1.0.0",
-  "type": "object",
-  "required": [
-    "name",
-    "port"
-  ],
-  "properties": {
-    "name": {
-      "allow_union": true,
-      "type": "string",
-      "description": "The name of the app to deploy.",
-      "maxLength": 20,
-      "example": "myapp"
-    },
-    "port": {
-      "allow_union": false,
-      "type": "integer",
-      "description": "Port where the app is hosted. When deployed this will be port on which we will deploy the app.",
-      "minimum": 1,
-      "maximum": 65535,
-      "example": 8000
-    },
-    "tags": {
-      "allow_union": true,
-      "type": "array",
-      "description": "The tags of the app to deploy.",
-      "items": {
-        "type": "object"
-      },
-      "example": [
-        {
-          "foo": "bar"
-        },
-        {
-          "x": "y"
-        }
-      ]
-    },
-    "description": {
-      "allow_union": true,
-      "type": "string",
-      "description": "The description of the app to deploy.",
-      "example": "This is a description of my app."
-    },
-    "force_upgrade": {
-      "allow_union": true,
-      "type": "boolean",
-      "description": "Whether to force upgrade the app even if it is currently being upgraded.",
-      "example": true
-    },
-    "app_type": {
-      "allow_union": true,
-      "type": "string",
-      "description": "The User defined type of app to deploy. Its only used for bookkeeping purposes.",
-      "example": "MyCustomAgent"
-    },
-    "image": {
-      "allow_union": true,
-      "type": "string",
-      "description": "The Docker image to deploy with the App."
-    },
-    "secrets": {
-      "allow_union": true,
-      "type": "array",
-      "description": "Outerbounds integrations to attach to the app. You can use the value you set in the `@secrets` decorator in your code.",
-      "items": {
-        "type": "string"
-      },
-      "example": [
-        "hf-token"
-      ]
-    },
-    "environment": {
-      "allow_union": true,
-      "type": "object",
-      "description": "Environment variables to deploy with the App.",
-      "additionalProperties": {
-        "oneOf": [
-          {
-            "type": "string"
-          },
-          {
-            "type": "number"
-          },
-          {
-            "type": "boolean"
-          },
-          {
-            "type": "object"
-          },
-          {
-            "type": "array"
-          }
-        ]
-      },
-      "example": {
-        "DEBUG": true,
-        "DATABASE_CONFIG": {
-          "host": "localhost",
-          "port": 5432
-        },
-        "ALLOWED_ORIGINS": [
-          "http://localhost:3000",
-          "https://myapp.com"
-        ]
-      }
-    },
-    "dependencies": {
-      "allow_union": false,
-      "type": "object",
-      "description": "The dependencies to attach to the app. Only one of the properties can be specified.\n",
-      "properties": {
-        "from_requirements_file": {
-          "type": "string",
-          "description": "The path to the requirements.txt file to attach to the app.",
-          "example": "requirements.txt"
-        },
-        "from_pyproject_toml": {
-          "type": "string",
-          "description": "The path to the pyproject.toml file to attach to the app.",
-          "example": "pyproject.toml"
-        },
-        "python": {
-          "type": "string",
-          "description": "The Python version to use for the app.\n",
-          "example": "3.10"
-        },
-        "pypi": {
-          "type": "object",
-          "description": "A dictionary of pypi dependencies to attach to the app.\nThe key is the package name and the value is the version.\n",
-          "example": {
-            "numpy": "1.23.0",
-            "pandas": ""
-          }
-        },
-        "conda": {
-          "type": "object",
-          "description": "A dictionary of pypi dependencies to attach to the app.\nThe key is the package name and the value is the version.\n",
-          "example": {
-            "numpy": "1.23.0",
-            "pandas": ""
-          }
-        }
-      }
-    },
-    "package": {
-      "allow_union": false,
-      "type": "object",
-      "description": "Configurations associated with packaging the app.\n",
-      "properties": {
-        "src_path": {
-          "type": "string",
-          "description": "The path to the source code to deploy with the App.",
-          "example": "./"
-        },
-        "suffixes": {
-          "type": "array",
-          "description": "A list of suffixes to add to the source code to deploy with the App.\n",
-          "items": {
-            "type": "string"
-          },
-          "example": [
-            ".py",
-            ".ipynb"
-          ]
-        }
-      }
-    },
-    "commands": {
-      "allow_union": false,
-      "type": "array",
-      "description": "A list of commands to run the app with. Cannot be configured from the CLI. Only used in `run` command.",
-      "items": {
-        "type": "string"
-      },
-      "example": [
-        "python app.py",
-        "python app.py --foo bar"
-      ]
-    },
-    "resources": {
-      "allow_union": true,
-      "type": "object",
-      "properties": {
-        "cpu": {
-          "type": "string",
-          "description": "CPU resource request and limit.",
-          "example": "500m",
-          "default": "1"
-        },
-        "memory": {
-          "type": "string",
-          "description": "Memory resource request and limit.",
-          "example": "512Mi",
-          "default": "4Gi"
-        },
-        "gpu": {
-          "type": "string",
-          "description": "GPU resource request and limit.",
-          "example": "1"
-        },
-        "disk": {
-          "type": "string",
-          "description": "Storage resource request and limit.",
-          "example": "1Gi",
-          "default": "20Gi"
-        }
-      }
-    },
-    "replicas": {
-      "allow_union": true,
-      "type": "object",
-      "description": "The number of replicas to deploy the app with.\n",
-      "properties": {
-        "min": {
-          "type": "integer",
-          "description": "The minimum number of replicas to deploy the app with.",
-          "example": 1
-        },
-        "max": {
-          "type": "integer",
-          "description": "The maximum number of replicas to deploy the app with.",
-          "example": 10
-        }
-      }
-    },
-    "health_check": {
-      "type": "object",
-      "allow_union": false,
-      "properties": {
-        "enabled": {
-          "type": "boolean",
-          "description": "Whether to enable health checks.",
-          "example": true,
-          "default": false
-        },
-        "path": {
-          "type": "string",
-          "description": "The path for health checks.",
-          "example": "/health"
-        },
-        "initial_delay_seconds": {
-          "type": "integer",
-          "description": "Number of seconds to wait before performing the first health check.",
-          "example": 10
-        },
-        "period_seconds": {
-          "type": "integer",
-          "description": "How often to perform the health check.",
-          "example": 30
-        }
-      }
-    },
-    "compute_pools": {
-      "allow_union": true,
-      "type": "array",
-      "description": "A list of compute pools to deploy the app to.\n",
-      "items": {
-        "type": "string"
-      },
-      "example": [
-        "default",
-        "large"
-      ]
-    },
-    "auth": {
-      "allow_union": false,
-      "type": "object",
-      "description": "Auth related configurations.\n",
-      "properties": {
-        "type": {
-          "type": "string",
-          "description": "The type of authentication to use for the app.\n",
-          "enum": [
-            "API",
-            "Browser"
-          ]
-        },
-        "public": {
-          "type": "boolean",
-          "description": "Whether the app is public or not.\n",
-          "default": true
-        }
-      }
-    },
-    "project": {
-      "type": "string",
-      "description": "The project name to deploy the app to.",
-      "experimental": true,
-      "allow_union": true
-    },
-    "branch": {
-      "type": "string",
-      "description": "The branch name to deploy the app to.",
-      "experimental": true,
-      "allow_union": true
-    },
-    "models": {
-      "type": "array",
-      "description": "model asset ids to include with the deployment. NO CLI Option for this Now.",
-      "experimental": true,
-      "allow_union": true,
-      "items": {
-        "type": "object",
-        "properties": {
-          "asset_id": {
-            "type": "string"
-          },
-          "asset_instance_id": {
-            "type": "string"
-          }
-        }
-      }
-    },
-    "data": {
-      "type": "array",
-      "description": "data asset ids to include with the deployment.",
-      "experimental": true,
-      "allow_union": true,
-      "items": {
-        "type": "object",
-        "properties": {
-          "asset_id": {
-            "type": "string"
-          },
-          "asset_instance_id": {
-            "type": "string"
-          }
-        }
-      }
-    }
-  }
-}