ray.serve.schema.HTTPOptionsSchema#
- pydantic model ray.serve.schema.HTTPOptionsSchema[source]#
Options to start the HTTP Proxy with.
- NOTE: This config allows extra parameters to make it forward-compatible (ie
older versions of Serve are able to accept configs from a newer versions, simply ignoring new parameters).
- field host: str = '0.0.0.0'#
Host for HTTP servers to listen on. Defaults to “0.0.0.0”, which exposes Serve publicly. Cannot be updated once Serve has started running. Serve must be shut down and restarted with the new host instead.
- field keep_alive_timeout_s: int = 90#
The HTTP proxy will keep idle connections alive for this duration before closing them when no requests are ongoing. Defaults to 90 seconds.
- field port: int = 8000#
Port for HTTP server. Defaults to 8000. Cannot be updated once Serve has started running. Serve must be shut down and restarted with the new port instead.
- field request_timeout_s: float | None = None#
The timeout for HTTP requests. Defaults to no timeout.
- field root_path: str = ''#
Root path to mount the serve application (for example, “/serve”). All deployment routes will be prefixed with this path. Defaults to “”.
- field ssl_ca_certs: str | None = None#
Path to the CA certificate file for verifying client certificates.
- field ssl_certfile: str | None = None#
Path to the SSL certificate file for HTTPS. If provided with ssl_keyfile, the HTTP server will use HTTPS. Cannot be updated once Serve has started.
- field ssl_keyfile: str | None = None#
Path to the SSL key file for HTTPS. If provided with ssl_certfile, the HTTP server will use HTTPS. Cannot be updated once Serve has started.
- validator validate_ssl_certfile » ssl_certfile[source]#