Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from this space and version HG-8.3.0

Peering Setup - Local Installations:

Table of Contents
maxLevel3

ProVision versions 8.2 and newer

PeeringDB Options:

Local Installations may opt to sync peering data via the PeeringDB API. 

Sync via PeeringDB API:

Info
ProVision only requires a Read Only API Key. For information on PeeringDB API keys, please refer to: https://docs.peeringdb.com/howto/api_keys/

To set a PeeringDB Account, go to Admin Settings → Peering, and enter the Read Only PeeringDB API key. Click "Test" to verify the connection.

Image Added

When done, click "Save Changes". If successful, the phrase "Account is set" will display above the API key form.

HTML
<div id="google_translate_element"></div>
<script type="text/javascript">
function googleTranslateElementInit() {
  new google.translate.TranslateElement({pageLanguage: 'en'}, 'google_translate_element');
}
</script>
<script type="text/javascript" src="//translate.google.com/translate_a/element.js?cb=googleTranslateElementInit"></script>

Peering Setup - Local Installations:

Table of ContentsmaxLevel3

ProVision versions 7.x and newer

...

For real-time updates, TTL may be set to 0. However, some users may experience severe lag with a TTL = 0; we recommend using a 10 to 15 minute or greater TTL if this occurs

ProVision versions 5.3.0 to 6.1.2 (Legacy)

For legacy set up (not recommended):

...

titleFor ProVision instances 5.3.0 to 6.1.2...

ProVision uses a locally-hosted mirror of the PeeringDB database in order to perform non-edit Peering functions. There are a few steps to take in order to set up your locally hosted instance to coordinate with PeeringDB information.

Warning

As of PeeringDB 2.0, SQL dump files are no longer provided. If you are using ProVision 5.3.0 or higher, you must follow this new install process. If you are using a lower version of ProVision, then please follow the instructions in the previous version of this page.

1) Create a new database to store the PeeringDB data. This must be on the same server as the database which is used by ProVision.

2) Download, install, and use the PeeringDB Python Client to populate the database.

The PeeringDB documentation is available here: http://peeringdb.github.io/peeringdb-py/

...

languagebash

...

.

...

It must be updated with the following variables to inform ProVision of the location of this new install. The username and password fields correspond to the username and password of the MySQL account which has access to the database (Not the username and password to your PeeringDB account).

Note

This can, but does not have to be, the same MySQL user which is used for the ProVision database. However, the ProVision MySQL user must have at least READ access to the PeeringDB database.

...

languagebash

...

 

...

Peering Constants

In globals.php, the following constants can be defined to tweak the Peering internals:

...

Expand
titlePeering Constants Descriptions and Syntax...

PEERINGDB_USERNAME

define('PEERINGDB_USERNAME''username');

Default value: none

The username for the account used to connect to the PeeringDB API

Instead of saving the username and password in the database, the values can be hard coded into globals.php

PEERINGDB_PASSWORD

define('PEERINGDB_PASSWORD''mypass');

Default value: none

The password for the account used to connect to the PeeringDB API

PEERINGDB_URL

define('PEERINGDB_URL''https://www.peeringdb.com/api/');


Default value: https://www.peeringdb.com/api/

The URL of the PeeringDB API. Alternate value: https://beta.peeringdb.com/api/

Info
titleNote: PeeringDB URL Change - (Affects only v8.0.1 and earlier)

Previous versions of PeeringDB allowed authenticated requests to https://peeringdb.com/api/. As of March 2022, PEERINGDB_URL must be set to https://www.peeringdb.com/api/ for authenticated requests to succeed.

Customers updated to v8.0.2 and later do not need to take any action and are not affected.

Local customers using versions 8.0.1 or earlier, and who are using Peering (or wish to start using Peering), should perform the following update(s) as applicable to their situation:


A) Existing local customers who already have their peeringdb account details saved in Provision should update PEERINGDB_URL in globals.php to:   

Code Block
define('PEERINGDB_URL', 'https://www.peeringdb.com/api/');


B) Customers who wish to begin using Peering (thus, do not already have saved peeringdb account details) will not be able to add their account via the GUI prior to v8.0.2. An attempt to do so will fail the "valid account test", which uses a hardcoded string value.

Instead, affected users must do both of the following:

B1) Save peeringdb account details using the API:

Code Block
https://[$your instance]/APIv2/spec.php?family=peering#/default/save_account

B2) Update PEERINGDB_URL in globals.php to:

Code Block
define('PEERINGDB_URL', 'https://www.peeringdb.com/api/');



PEERINGDB_CACHE_TTL

define('PEERINGDB_CACHE_TTL', 43200);

Default value: 43200 (12 hours)

How often (in seconds) to purge the cached PeeringDB API calls. If a customer wants real time access, this can be set to 0. 

If experiencing major lag issues with real time access, it is recommended to increase to increase the cache TTL from 0 to 5, 10, or 15 minutes. 


...