Skip to content

Commit

Permalink
docs: add cache page
Browse files Browse the repository at this point in the history
  • Loading branch information
natesales committed Jun 11, 2023
1 parent d9c79bc commit 5c2e738
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
20 changes: 20 additions & 0 deletions docs/docs/caching.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Caching
sidebar_position: 9
---

Pathvector relies on external datasources to generate configuration, such as PeeringDB, IRR databases, and the RPKI. There are various mechanisms to cache this data to decrease latency and reduce load on these external services.

## RPKI

Networks should already be running their own RTR (RPKI to Router) server such as [stayrtr](https://github.com/bgp/stayrtr) or [rtrtr](https://github.com/NLnetLabs/rtrtr).

## IRR

## PeeringDB

Pathvector has an internal PeeringDB cache that stores PeeringDB objects *for the duration of a single `pathvector generate` run*. This does not cache for longer than a single command invocation.

### PeeringDB Local Cache

To cache PeeringDB data persistently, you can set the global [`peeringdb-url`](https://pathvector.io/docs/configuration/#peeringdb-url) option to a local [PeeringDB cache server](https://github.com/natesales/peeringdb-cache).
2 changes: 1 addition & 1 deletion docs/docs/integrations/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Integrations",
"position": 11
"position": 100
}

0 comments on commit 5c2e738

Please sign in to comment.