Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

new docs site updates #6157

Merged
merged 37 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from 34 commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
87addd3
absolute link in header propagation
shorgi Aug 9, 2024
66b4666
absolute path in defer-support.mdx
shorgi Aug 9, 2024
4a680e9
absolute path in file-uploads.mdx
shorgi Aug 9, 2024
2882acb
absolute path in subscription-support.mdx
shorgi Aug 9, 2024
e3f6182
absolute path in subscription-callback-protocol.mdx
shorgi Aug 9, 2024
26ec794
absolute path in subscription-multipart-protocol.mdx
shorgi Aug 9, 2024
8a10a59
absolute path in authorization.mdx
shorgi Aug 9, 2024
3b0278d
absolute path in persisted-queries.mdx
shorgi Aug 9, 2024
45cec87
absolute path in cors.mdx
shorgi Aug 9, 2024
f1b563f
use absolute paths for docs references
shorgi Aug 15, 2024
f9fce9d
use absolute paths for docs references
shorgi Aug 15, 2024
b2604f4
Merge branch 'main' into version-0.x-docs-replatform
shorgi Aug 15, 2024
cb92d02
fix non-working TOC links by fixing table formatting
shorgi Aug 16, 2024
54037c4
fix link
shorgi Aug 16, 2024
2fd4106
update links
shorgi Aug 19, 2024
71c25e5
fix link
shorgi Aug 20, 2024
048fa48
fix link
shorgi Aug 20, 2024
efee2d4
fix link
shorgi Aug 20, 2024
f1c3368
Merge branch 'main' into main-docs-replatform
shorgi Aug 28, 2024
a792243
fix links
shorgi Aug 28, 2024
e630c51
update link for new new IA
shorgi Sep 19, 2024
5400175
Merge branch 'main' into main-docs-replatform
shorgi Sep 27, 2024
a273f4b
move router-specific defer content into defer-support page
shorgi Sep 30, 2024
fe769eb
remove usage of RedisTLS shared component
shorgi Sep 30, 2024
ada0873
update usage reporting via otlp, from router 2.x update
shorgi Oct 3, 2024
4a6d756
add native query planner to config overview
shorgi Oct 3, 2024
062c20b
fix link for docs-rewrite
shorgi Oct 3, 2024
ea04911
fix links for docs-rewrite
shorgi Oct 3, 2024
891d3f2
Merge branch 'main' into main-docs-replatform
shorgi Oct 3, 2024
293f1a6
remove SummitCallouts
shorgi Oct 3, 2024
7e23851
fix link
shorgi Oct 3, 2024
544a657
Merge branch 'main' into main-docs-replatform
shorgi Oct 22, 2024
3a1d20b
reorganize docs for new docs site (#6211)
shorgi Nov 1, 2024
11f4371
Merge branch 'main' into main-docs-replatform
shorgi Nov 1, 2024
1a54efa
Merge branch 'main' into main-docs-replatform
shorgi Nov 5, 2024
ecfc4ef
fix link
shorgi Nov 5, 2024
d047744
Merge branch 'main' into main-docs-replatform
shorgi Nov 7, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,6 @@
# Previous git submodules
dockerfiles/federation-demo
dockerfiles/federation2-demo

# macOS
.DS_Store
2 changes: 1 addition & 1 deletion docs/shared/native-plugin-notice.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
- Native plugins require familiarity with programming in Rust.
- Native plugins require compiling a custom router binary from source, which can introduce unexpected behavior in your router that's difficult to diagnose and support.

Instead, for most router customizations, Apollo recommends creating either a [Rhai script](https://www.apollographql.com/docs/router/customizations/rhai/) or an [external coprocessor](https://www.apollographql.com/docs/router/customizations/coprocessor). Both of these customizations are supported by Apollo and provide strong separation of concerns and fault isolation.
Instead, for most router customizations, Apollo recommends creating either a [Rhai script](https://www.apollographql.com/docs/graphos/routing/customization/rhai/) or an [external coprocessor](https://www.apollographql.com/docs/router/customizations/coprocessor). Both of these customizations are supported by Apollo and provide strong separation of concerns and fault isolation.

If you must create a native plugin, please [open a GitHub issue](https://github.com/apollographql/router/issues), and Apollo can investigate adding the custom capability to the stock router binary.
128 changes: 7 additions & 121 deletions docs/source/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,130 +2,16 @@
"title": "Self-Hosted Router",
"algoliaFilters": ["docset:router"],
"sidebar": {
"Introduction": "/",
"Quickstart": "/quickstart",
"Moving from @apollo/gateway": "/migrating-from-gateway",
"Federation Version Support": "/federation-version-support",
"Enterprise Features": ["/enterprise-features", ["enterprise"]],
"Configuring the Router": {
"Overview": "/configuration/overview",
"Caching": {
"In-Memory Caching": "/configuration/in-memory-caching",
"Distributed Caching": ["/configuration/distributed-caching", ["enterprise"]],
"Entity Caching": ["/configuration/entity-caching", ["enterprise", "preview"]]
},
"Debugging": {
"Errors": "/errors",
"Telemetry": "/configuration/telemetry/overview",
"Subgraph Error Inclusion": "/configuration/subgraph-error-inclusion"
},
"Networking": {
"Header Propagation": "/configuration/header-propagation",
"Traffic Shaping": "/configuration/traffic-shaping"
},
"Security": {
"CORS": "/configuration/cors",
"CSRF Prevention": "/configuration/csrf",
"JWT Authentication": ["/configuration/authn-jwt", ["enterprise"]],
"Authorization": ["/configuration/authorization", ["enterprise"]],
"Subgraph Authentication": "/configuration/authn-subgraph",
"Operation Limits": [
"/configuration/operation-limits",
[
"enterprise"
]
],
"Safelisting with Persisted Queries": [
"/configuration/persisted-queries",
[
"enterprise"
]
],
"Demand Control" : [
"/executing-operations/demand-control",
[
"enterprise"
]
],
"Privacy and Data Collection": "/privacy"
}
},
"Executing Operations": {
"Build and Run Queries": "/executing-operations/build-run-queries",
"@defer Support": "/executing-operations/defer-support",
"Request Format": "/executing-operations/requests",
"Query Batching": [
"/executing-operations/query-batching",
[
"enterprise"
]
],
"GraphQL Subscriptions": {
"Subscriptions Setup": ["/executing-operations/subscription-support", ["enterprise"]],
"Subgraph Protocol: HTTP Callback": [
"/executing-operations/subscription-callback-protocol",
["enterprise", "preview"]
],
"Client Protocol: HTTP Multipart": ["/executing-operations/subscription-multipart-protocol", ["enterprise"]]
}
"Routing": {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Future PR: adapt config.json to be a manifest of new docs files

"About Router": "/routing/about-router"
},
"Telemetry and Monitoring": {
"Overview": "/configuration/telemetry/overview",
"GraphOS Reporting": "/configuration/telemetry/apollo-telemetry",
"Client Awareness": "/managed-federation/client-awareness",
"Log Exporters": {
"Configuration": "/configuration/telemetry/exporters/logging/overview",
"Stdout": "/configuration/telemetry/exporters/logging/stdout"
"Reference": {
"Migration": {
"From Gateway": "/reference/migration/from-gateway"
},
"Metrics Exporters": {
"Configuration": "/configuration/telemetry/exporters/metrics/overview",
"Datadog": "/configuration/telemetry/exporters/metrics/datadog",
"Dynatrace": "/configuration/telemetry/exporters/metrics/dynatrace",
"New Relic": "/configuration/telemetry/exporters/metrics/new-relic",
"OTLP": "/configuration/telemetry/exporters/metrics/otlp",
"Prometheus": "/configuration/telemetry/exporters/metrics/prometheus"
},
"Trace exporters": {
"Configuration": "/configuration/telemetry/exporters/tracing/overview",
"Datadog": "/configuration/telemetry/exporters/tracing/datadog",
"Dynatrace": "/configuration/telemetry/exporters/tracing/dynatrace",
"Jaeger": "/configuration/telemetry/exporters/tracing/jaeger",
"New Relic": "/configuration/telemetry/exporters/tracing/new-relic",
"OTLP": "/configuration/telemetry/exporters/tracing/otlp",
"Zipkin": "/configuration/telemetry/exporters/tracing/zipkin"
},
"Instrumentation": {
"Instruments": "/configuration/telemetry/instrumentation/instruments",
"Events": "/configuration/telemetry/instrumentation/events",
"Conditions": "/configuration/telemetry/instrumentation/conditions",
"Spans": "/configuration/telemetry/instrumentation/spans",
"Selectors": "/configuration/telemetry/instrumentation/selectors",
"Standard Attributes": "/configuration/telemetry/instrumentation/standard-attributes",
"Standard Instruments": "/configuration/telemetry/instrumentation/standard-instruments"
"Router": {
"Configuration": "/reference/router/configuration"
}
},
"Containerization": {
"Overview": "/containerization/overview",
"Deploy on Kubernetes": "/containerization/kubernetes",
"Run with Docker": "/containerization/docker",
"Health Checks": "/configuration/health-checks"
},
"Managed Federation": {
"Overview": "https://www.apollographql.com/docs/federation/managed-federation/overview",
"Setup": "https://www.apollographql.com/docs/federation/managed-federation/setup",
"GraphOS Studio Features": "https://www.apollographql.com/docs/graphos/graphs/federated-graphs"
},
"Customizations": {
"Overview": "/customizations/overview",
"Rhai Scripts": "/customizations/rhai",
"Rhai API Reference": "/customizations/rhai-api",
"External Coprocessing": ["/customizations/coprocessor", ["enterprise"]],
"Native Rust Plugins": "/customizations/native",
"Custom Router Binary": "/customizations/custom-binary"
},
"Subgraph Support": {
"Subgraph-Compatible Libraries": "https://www.apollographql.com/docs/federation/v2/other-servers/",
"Subgraph Specification": "https://www.apollographql.com/docs/federation/v2/federation-spec/"
}
}
}
34 changes: 0 additions & 34 deletions docs/source/configuration/experimental_query_planner_mode.mdx

This file was deleted.

22 changes: 11 additions & 11 deletions docs/source/enterprise-features.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ For details on these features, see [this blog post](https://blog.apollographql.c
To enable support for GraphOS Router Enterprise features:

- Your organization must have a [GraphOS Enterprise plan](https://www.apollographql.com/pricing/).
- You must run GraphOS Router v1.12. [Download the latest version.](./quickstart#download-options)
- You must run GraphOS Router v1.12. [Download the latest version.](/router/quickstart#download-options)
- Certain Enterprise features might require a later router version. See a particular feature's documentation for details.
- Your router instances must connect to GraphOS with a **graph API key** and **graph ref** associated with your organization.
- You connect your router to GraphOS by setting [these environment variables](./configuration/overview/#environment-variables) when starting the router.
- You connect your router to GraphOS by setting [these environment variables](/router/configuration/overview/#environment-variables) when starting the router.
- If your router _already_ connects to your GraphOS Enterprise organization, no further action is required.

After enabling support, you can begin using all Enterprise features. Consult [the documentation for each feature](#list-of-features) to learn more.
Expand Down Expand Up @@ -82,7 +82,7 @@ With an offline license, a router can either be fully disconnected from GraphOS

<Note>

A router using an offline license requires [the use of local manifests](./configuration/persisted-queries/#experimental_local_manifests) when using [safelisting with persisted queries](./configuration/persisted-queries), otherwise it will not work as designed when the router is disconnected from Uplink.
A router using an offline license requires [the use of local manifests](/router/configuration/persisted-queries/#experimental_local_manifests) when using [safelisting with persisted queries](/router/configuration/persisted-queries), otherwise it will not work as designed when the router is disconnected from Uplink.

</Note>

Expand All @@ -100,9 +100,9 @@ Follow these steps to configure an GraphOS Router to use an offline Enterprise l

1. Provide the offline license to your router on startup. The router accepts an offline license in a few ways:

1. [`--license <license_path>`](./configuration/overview/#--license) CLI option, with an argument containing an absolute or relative path to an offline license file
1. [`APOLLO_ROUTER_LICENSE_PATH`](./configuration/overview/#--license) environment variable, containing an absolute or relative path to an offline license file
1. [`APOLLO_ROUTER_LICENSE`](./configuration/overview/#--license) environment variable, containing the stringified contents of an offline license file
1. [`--license <license_path>`](/router/configuration/overview/#--license) CLI option, with an argument containing an absolute or relative path to an offline license file
1. [`APOLLO_ROUTER_LICENSE_PATH`](/router/configuration/overview/#--license) environment variable, containing an absolute or relative path to an offline license file
1. [`APOLLO_ROUTER_LICENSE`](/router/configuration/overview/#--license) environment variable, containing the stringified contents of an offline license file

<Note>

Expand All @@ -113,11 +113,11 @@ Follow these steps to configure an GraphOS Router to use an offline Enterprise l

1. Configure the router to use a local supergraph schema by setting one of the following:

* [`--s/-supergraph`](./configuration/overview/#-s----supergraph) CLI option, with an argument containing an absolute or relative path to supergraph schema file
* [`APOLLO_SUPERGRAPH_PATH`](./configuration/overview/#-s----supergraph) environment variable, containing an absolute or relative path to supergraph schema file
* [`APOLLO_SUPERGRAPH_URLS`](./configuration/overview/#-s----supergraph) environment variable, containing URLs to supergraph schemas
* [`--s/-supergraph`](/router/configuration/overview/#-s----supergraph) CLI option, with an argument containing an absolute or relative path to supergraph schema file
* [`APOLLO_SUPERGRAPH_PATH`](/router/configuration/overview/#-s----supergraph) environment variable, containing an absolute or relative path to supergraph schema file
* [`APOLLO_SUPERGRAPH_URLS`](/router/configuration/overview/#-s----supergraph) environment variable, containing URLs to supergraph schemas

1. (**Recommended**) Configure the router to report usage metrics to GraphOS in a best-effort basis by setting both the [`APOLLO_KEY`](./configuration/overview/#apollo_key) and [`APOLLO_GRAPH_REF`](./configuration/overview#apollo_graph_ref) environment variables.
1. (**Recommended**) Configure the router to report usage metrics to GraphOS in a best-effort basis by setting both the [`APOLLO_KEY`](/router/configuration/overview/#apollo_key) and [`APOLLO_GRAPH_REF`](/router/configuration/overview#apollo_graph_ref) environment variables.

These metrics are necessary for several important GraphOS features (operations checks, field insights, operation traces, contracts). Sending them best-effort incurs no performance or uptime penalties.

Expand Down Expand Up @@ -168,7 +168,7 @@ These steps work both for running the router executable directly (`./router`) an

## Disabling Enterprise features

To disable an Enterprise feature, remove all of its associated configuration keys from your router's [YAML config file](./configuration/overview/#yaml-config-file).
To disable an Enterprise feature, remove all of its associated configuration keys from your router's [YAML config file](/router/configuration/overview/#yaml-config-file).

## Grace period for expired plans

Expand Down
15 changes: 0 additions & 15 deletions docs/source/executing-operations/build-run-queries.mdx

This file was deleted.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading