Skip to content

Commit

Permalink
docs: add rover license fetch command (#1795)
Browse files Browse the repository at this point in the history
  • Loading branch information
shorgi authored Dec 14, 2023
1 parent a634725 commit 4af6bcc
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
38 changes: 38 additions & 0 deletions docs/source/commands/license.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: The Rover license command
description: Manage GraphOS Enterprise licenses, including offline licenses, with the rover license command
minVersion: 0.22.0
---

Rover commands that manage Enterprise licenses for Apollo begin with `rover license`.

## Fetch offline Enterprise license

### `license fetch`

<Tip>

Offline Enterprise license support is available on an as-needed basis. Send a request to your Apollo contact to enable it for your GraphOS Studio organization.

</Tip>

Run `rover license fetch` to fetch an offline license from GraphOS for a graph with a GraphOS Enterprise plan. Use the fetched license to enable enterprise features while running offline and disconnected from GraphOS, as supported when [running the Apollo Router with an offline license](/router/enterprise-features/#set-up-offline-license-for-the-apollo-router).

Specify the graph to fetch from with a `--graph-id` argument:

```bash
rover license fetch --graph-id <apollo-graph-id>
```

<Note>

* An offline Enterprise license is valid for the lesser of the duration of your contract with Apollo, or one year, with an added grace period of 28 days.

* You are responsible for keeping your offline license files up to date within your infrastructure by rerunning `rover license fetch` to fetch updated license files.

</Note>

#### Related topics

* The (online) [Enterprise license](/router/enterprise-features/#offline-enterprise-license) that a router connected to GraphOS gets from [Apollo Uplink](/federation/managed-federation/uplink/)
* [Offline Enterprise license](/router/enterprise-features/#offline-enterprise-license)
1 change: 1 addition & 0 deletions docs/source/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
"dev": "/commands/dev",
"explain": "/commands/explain",
"graph": "/commands/graphs",
"license": "/commands/license",
"persisted-queries": "/commands/persisted-queries",
"readme": "/commands/readmes",
"subgraph": "/commands/subgraphs",
Expand Down

0 comments on commit 4af6bcc

Please sign in to comment.