add documentation for spaceport #445

garypen · 2022-02-11T10:40:49Z

Minimal documentation to support spaceport configuration.

Separate the graph and spaceport configuration into their own sections. Re-order so graph comes before spaceport, which makes most sense.

abernix · 2022-02-11T13:11:13Z

docs/source/configuration.mdx

+The reference fulfills the same function as the APOLLO_GRAPH_REF environment variable.
+NB: These environment variables are *not* currently recognised by the router. This is being tracked by [issue](https://github.com/apollographql/router/issues/425)
+
+### Spaceport Configuration


Suggested change

### Spaceport Configuration

### Spaceport configuration

abernix · 2022-02-11T13:11:19Z

docs/source/configuration.mdx

+  listener: 0.0.0.0:50051
+```
+
+#### Internal Spaceport


Suggested change

#### Internal Spaceport

#### Internal spaceport

abernix · 2022-02-11T13:11:28Z

docs/source/configuration.mdx

+This is the default and is most appropriate for evaluations, demos, development support and generally getting started. This requires no configuration by default and will be automatically started if the graph configuration is present.
+In this mode it is possible to further configure the address at which the internal spaceport is listening and the address of the spaceport to use. This should only be necessary if there is a clash on the default port, for instance if running multiple routers on the same system or clashing with another application.
+
+#### External Spaceport


Suggested change

#### External Spaceport

#### External spaceport

abernix · 2022-02-11T13:11:47Z

docs/source/configuration.mdx

+
+Spaceport reports usage data to the Apollo ingress. You can see how it is configured in the examples above.
+
+NB: This component is still evolving and you should expect functionality to change and evolve here. We are actively seeking user feedback as we work to shape this component.


Suggested change

NB: This component is still evolving and you should expect functionality to change and evolve here. We are actively seeking user feedback as we work to shape this component.

> Note: This component is still evolving and you should expect functionality to change and evolve here. We are actively seeking user feedback as we work to shape this component.

abernix · 2022-02-11T13:17:55Z

docs/source/configuration.mdx

+  key: service:<redacted>
+```
+
+You must configure the graph section. If you specify a graph section, then both the reference and the key must be specified. The reference must refer to a valid graph/version combination against which statistics are reported. The Key must be a valid API key which can be used for reporting statistics.


Suggested change

You must configure the graph section. If you specify a graph section, then both the reference and the key must be specified. The reference must refer to a valid graph/version combination against which statistics are reported. The Key must be a valid API key which can be used for reporting statistics.

You must configure the `graph` section. If you specify a `graph` section, then both the `reference` and the `key` must be specified. The `reference` must refer to a valid graph/variant combination (i.e., the "graph ref") against which statistics are reported. The `key` must be a valid Apollo Studio API key which can be used for reporting statistics (a [Studio Graph _Contributor_ token](https://www.apollographql.com/docs/studio/org/members/#organization-wide-member-roles) is appropriate).

abernix · 2022-02-11T13:18:06Z

docs/source/configuration.mdx

+
+You must configure the graph section. If you specify a graph section, then both the reference and the key must be specified. The reference must refer to a valid graph/version combination against which statistics are reported. The Key must be a valid API key which can be used for reporting statistics.
+For more details on this process, refer to the [usage reporting documentation](https://www.apollographql.com/docs/studio/metrics/usage-reporting/)
+The key fulfills the same function as the APOLLO_KEY environment variable.


Suggested change

The key fulfills the same function as the APOLLO_KEY environment variable.

The key fulfills the same function as the `APOLLO_KEY` environment variable.

abernix · 2022-02-11T13:18:13Z

docs/source/configuration.mdx

+You must configure the graph section. If you specify a graph section, then both the reference and the key must be specified. The reference must refer to a valid graph/version combination against which statistics are reported. The Key must be a valid API key which can be used for reporting statistics.
+For more details on this process, refer to the [usage reporting documentation](https://www.apollographql.com/docs/studio/metrics/usage-reporting/)
+The key fulfills the same function as the APOLLO_KEY environment variable.
+The reference fulfills the same function as the APOLLO_GRAPH_REF environment variable.


Suggested change

The reference fulfills the same function as the APOLLO_GRAPH_REF environment variable.

The `reference` fulfills the same function as the `APOLLO_GRAPH_REF` environment variable.

abernix · 2022-02-11T13:18:39Z

docs/source/configuration.mdx

+For more details on this process, refer to the [usage reporting documentation](https://www.apollographql.com/docs/studio/metrics/usage-reporting/)
+The key fulfills the same function as the APOLLO_KEY environment variable.
+The reference fulfills the same function as the APOLLO_GRAPH_REF environment variable.
+NB: These environment variables are *not* currently recognised by the router. This is being tracked by [issue](https://github.com/apollographql/router/issues/425)


Suggested change

NB: These environment variables are *not* currently recognised by the router. This is being tracked by [issue](https://github.com/apollographql/router/issues/425)

> Note: These environment variables are *not* currently recognised by the router. This is being tracked by [#425](https://github.com/apollographql/router/issues/425)

abernix · 2022-02-11T13:43:50Z

Meh, well, my suggested changes can't be auto-clicked in now, but it was mostly formatting.

Follows up: #445 Follows up: #309 Relates to: #66 Relates to: #444

add documentation for spaceport

2e1acd4

Minimal documentation to support spaceport configuration.

garypen requested review from o0Ignition0o and abernix February 11, 2022 10:40

o0Ignition0o approved these changes Feb 11, 2022

View reviewed changes

documentation review feedback

6e480d1

Separate the graph and spaceport configuration into their own sections. Re-order so graph comes before spaceport, which makes most sense.

garypen requested review from BrynCooke and Geal February 11, 2022 11:33

Geal approved these changes Feb 11, 2022

View reviewed changes

abernix linked an issue Feb 11, 2022 that may be closed by this pull request

add documentation for spaceport #444

Closed

garypen merged commit 1a34cc3 into main Feb 11, 2022

garypen deleted the garypen/444-spaceport-docs branch February 11, 2022 13:34

abernix reviewed Feb 11, 2022

View reviewed changes

abernix assigned garypen Feb 11, 2022

abernix added a commit that referenced this pull request Feb 17, 2022

docs: Spaceport docs formatting and editorial

0fda28d

Follows up: #445 Follows up: #309 Relates to: #66 Relates to: #444

abernix mentioned this pull request Feb 17, 2022

docs: Spaceport docs formatting and editorial #495

Merged

abernix added a commit that referenced this pull request Feb 17, 2022

docs: Spaceport docs formatting and editorial (#495)

89a320e

Follows up: #445 Follows up: #309 Relates to: #66 Relates to: #444

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add documentation for spaceport #445

add documentation for spaceport #445

garypen commented Feb 11, 2022

abernix Feb 11, 2022

abernix Feb 11, 2022

abernix Feb 11, 2022

abernix Feb 11, 2022

abernix Feb 11, 2022

abernix Feb 11, 2022

abernix Feb 11, 2022

abernix Feb 11, 2022

abernix commented Feb 11, 2022


		Spaceport reports usage data to the Apollo ingress. You can see how it is configured in the examples above.

		NB: This component is still evolving and you should expect functionality to change and evolve here. We are actively seeking user feedback as we work to shape this component.

	NB: This component is still evolving and you should expect functionality to change and evolve here. We are actively seeking user feedback as we work to shape this component.
	> Note: This component is still evolving and you should expect functionality to change and evolve here. We are actively seeking user feedback as we work to shape this component.

	The key fulfills the same function as the APOLLO_KEY environment variable.
	The key fulfills the same function as the `APOLLO_KEY` environment variable.

	The reference fulfills the same function as the APOLLO_GRAPH_REF environment variable.
	The `reference` fulfills the same function as the `APOLLO_GRAPH_REF` environment variable.

	NB: These environment variables are not currently recognised by the router. This is being tracked by [issue](https://github.com/apollographql/router/issues/425)
	> Note: These environment variables are not currently recognised by the router. This is being tracked by [#425](https://github.com/apollographql/router/issues/425)

add documentation for spaceport #445

add documentation for spaceport #445

Conversation

garypen commented Feb 11, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abernix commented Feb 11, 2022