Skip to content

Commit

Permalink
docs: fix up some rover dev docs (#1517)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
EverlastingBugstopper authored Feb 17, 2023
1 parent 12a3f9f commit c6694d7
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/source/commands/dev.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,16 @@ If you don't pass the `--schema <PATH>` 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 <ROUTER_CONFIG_PATH>` 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).
Expand All @@ -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.

0 comments on commit c6694d7

Please sign in to comment.