From c6694d7fb06a427ad7747c869530ee59fc3baab5 Mon Sep 17 00:00:00 2001 From: Avery Harnish Date: Fri, 17 Feb 2023 11:20:50 -0600 Subject: [PATCH] docs: fix up some rover dev docs (#1517) 1) document that health checks are disabled by default 2) correctly document version setting (remove the `v` prefix) 3) remove the inaccurate statement that `--router-config` is not watched for changes --- docs/source/commands/dev.mdx | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/source/commands/dev.mdx b/docs/source/commands/dev.mdx index cd84cf1e7..ba3c3cd48 100644 --- a/docs/source/commands/dev.mdx +++ b/docs/source/commands/dev.mdx @@ -60,14 +60,16 @@ If you don't pass the `--schema ` argument, `rover dev` will introspect th If you stop an attached `rover dev` process (by pressing `CTRL+C`), the supergraph will de-compose the removed subgraph and reload the router. +### Health check + +By deafult, the health check endpoint is disabled in `rover dev`. You can enable it again by enabling it in a router configuration YAML file and passing it to `rover dev` via the `--router-config` argument described in the following section. + ### Advanced configuration To configure advanced router functionality like CORS settings or header passthrough for subgraphs, you can pass a valid [router configuration YAML file](/router/configuration/overview#yaml-config-file) to `rover dev` via the `--router-config ` argument. Note that only the main `rover dev` process uses this router configuration file when starting the router. If you specify a different listen address with `supergraph.listen`, all other `rover dev` processes need to pass the same values to `--supergraph-port` and `--supergraph-address`, and/or pass the same router configuration file path via `--router-config`. -**Important:** `rover dev` does not watch changes made to a router configuration file passed via `--router-config`. - ### Federation 2 ELv2 license The first time you use Federation 2 composition on a particular machine, Rover prompts you to accept the terms and conditions of the [ELv2 license](https://www.apollographql.com/docs/resources/elastic-license-v2-faq/). On future invocations, Rover remembers that you already accepted the license and doesn't prompt you again (even if you update Rover). @@ -76,4 +78,4 @@ The ELv2-licensed plugins, `supergraph` (built from [this source](https://github ### Versioning -By default, `rover dev` will select a recent version of the router and composition to use for you. You can override these by setting the environment variables `APOLLO_ROVER_DEV_COMPOSITION_VERSION=v2.0.0` and/or `APOLLO_ROVER_DEV_ROUTER_VERSION=v1.0.0`. By default, `rover dev` will always use a composition library with a major version of 2, and a router with a major version of 1. If you already have the plugins installed, you can pass `--skip-update` to `rover dev` in order to keep the plugins at the same version. +By default, `rover dev` will select a recent version of the router and composition to use for you. You can override these by setting the environment variables `APOLLO_ROVER_DEV_COMPOSITION_VERSION=2.0.0` and/or `APOLLO_ROVER_DEV_ROUTER_VERSION=1.0.0`. By default, `rover dev` will always use a composition library with a major version of 2, and a router with a major version of 1. If you already have the plugins installed, you can pass `--skip-update` to `rover dev` in order to keep the plugins at the same version.