ray/doc/source/serve
shrekris-anyscale 510a0e038c
[Serve] Add host and port options to the Serve config file (#27026)
The Serve CLI and REST API always sets the host to `0.0.0.0` and the port to Serve's default. This change adds `host` and `port` as top level options in the Serve config file, so users can manually set the host and port of their Serve application to different values.

This change introduces a new Serve config file format:

```yaml
import_path: ...

runtime_env: ...

host: ...

port: ...

deployments: ...
    ...
```

`host` and `port` are optional and can be omitted. A running Serve application's `host` and `port` cannot be changed. If a user tries to `serve deploy` a config file with different `host` and `port` options than an already-running Serve application, `serve deploy` will fail without making any changes to the application. The user must `serve shutdown` their application and restart it with `serve deploy` to change their `host` and `port`.

**Follow-Up Items**
* The following CLI commands should **not** start Serve automatically. They should check whether Serve is running and perform some sort of no-op if it's not. That would alleviate the concern that the user starts Serve by accident through a `GET` request and needs to deal with default `host`/`port` options. Corresponding docs should also be updated.
    * `serve status`
    * `serve config`
    * `serve shutdown`
2022-07-28 11:26:46 -05:00
..
deployment-graph [Deployment Graph] Add visualization cookbook (#25112) 2022-06-06 11:05:58 -07:00
doc_code [Serve] [Docs] Create end-to-end documentation example for Serve REST API and CLI (#25936) 2022-06-24 14:44:39 -07:00
tutorials [Docs] [Serve] Has a consistent landing page style (#26029) 2022-07-08 11:58:21 -07:00
architecture.md [Serve][Doc] Convert Serve doc sources from rst to myst (#24657) 2022-05-10 14:04:17 -07:00
architecture.svg Revert "[docs] Clean up doc structure (first part) (#21667)" (#21763) 2022-01-20 15:30:56 -08:00
autoscaling.md [Serve][Doc] Autoscaling (#25646) 2022-06-22 15:32:18 -05:00
deploying-serve.md [Serve] Add host and port options to the Serve config file (#27026) 2022-07-28 11:26:46 -05:00
deployment-graph.md [Deployment Graph] Add visualization cookbook (#25112) 2022-06-06 11:05:58 -07:00
faq.md [Serve][Doc] Split core-apis to key concepts and user guide (#24713) 2022-05-20 10:56:34 -07:00
getting_started.md [Docs] [Serve] Has a consistent landing page style (#26029) 2022-07-08 11:58:21 -07:00
handle-guide.md [Serve][Doc] Split core-apis to key concepts and user guide (#24713) 2022-05-20 10:56:34 -07:00
handling-dependencies.md [Serve][Doc] Split core-apis to key concepts and user guide (#24713) 2022-05-20 10:56:34 -07:00
http-adapters.md Revert "Revert "[AIR][Serve] Rename ModelWrapperDeployment -> PredictorDeployment"" (#26231) 2022-07-05 13:26:49 -07:00
http-guide.md [Serve][Doc] Split core-apis to key concepts and user guide (#24713) 2022-05-20 10:56:34 -07:00
index.md [Docs] [Serve] Has a consistent landing page style (#26029) 2022-07-08 11:58:21 -07:00
key-concepts.md [Docs] [Serve] Has a consistent landing page style (#26029) 2022-07-08 11:58:21 -07:00
logo.svg Revert "[docs] Clean up doc structure (first part) (#21667)" (#21763) 2022-01-20 15:30:56 -08:00
managing-deployments.md [Serve] Promote autoscaling feature (#26393) 2022-07-13 14:38:38 -05:00
ml-models.md [Docs] [Serve] Has a consistent landing page style (#26029) 2022-07-08 11:58:21 -07:00
monitoring.md [Serve][Doc] Convert Serve doc sources from rst to myst (#24657) 2022-05-10 14:04:17 -07:00
package-ref.md [Docs] [Serve] Has a consistent landing page style (#26029) 2022-07-08 11:58:21 -07:00
performance.md [serve][docs] Replaced term 'actor_init_options' with 'ray_actor_options' in documentation (#25808) 2022-06-15 15:21:24 -05:00
production.md [Serve] Add host and port options to the Serve config file (#27026) 2022-07-28 11:26:46 -05:00
user-guide.md [Docs] [Serve] Has a consistent landing page style (#26029) 2022-07-08 11:58:21 -07:00