Versions Compared

Old Version 14

changes.mady.by.user The Force

Saved on

compared with

New Version Current

changes.mady.by.user The Force

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from this space and version 8.2.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 (recommended), or by self-managing a local database utilizing a cron task to sync data - this option is only recommended for advanced users experiencing heavy loads. 

Sync via PeeringDB API (Recommended):

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.

Self-Manage a Local DB (Not Recommended):

Instead of making API requests to PeeringDB, you can now make them to a local PeeringDB copy and sync through either a separate cron job or by using the associated Scheduler Task.


Note
This option is only recommended for advanced users experiencing heavy loads. Most users should utilize the API Key option, above.
Expand
titleClick here for instructions...

Define Constants

To link a provision instance to PeeringDB, define these constants in globals.php, where the values match the actual database that is hosting PeeringDB. :


Code Block
define('PEERINGDB_HOST', 'localhost');

define('PEERINGDB_USERNAME', 'root');

define('PEERINGDB_PASSWORD', 'mypass');

define('PEERINGDB_NAME', ‘peeringdb');


This will change Settings section in the Peering area so it will now show the database status, instead of asking you for an account API KEY.


Installation:

For local customers, they can find install instructions for the PeeringDB Python Client here:

https://peeringdb.github.io/peeringdb-py/

You may create a config file as follows:

Code Block
$ cat .peeringdb/config.yaml 
orm:
  backend: django_peeringdb
  database:
    engine: mysql
    host: localhost
    name: peeringdb
    password: supers3cr3t
    port: 0
    user: peeringdb
  migrate: true
  secret_key: ''
sync:
  api_key: YOUR_API_KEY
  only: []
  password: ''
  strip_tz: 1
  timeout: 0
  url: https://www.peeringdb.com/api
  user: ''




Sync set up:

To run a sync of PeeringDB:

Code Block
. pdbvenv/bin/activate
peeringdb sync


The database can also be synced using the scheduler. The task needs to know the location of the python virtual environment where peeringdb-py is installed and the directory that hosts the peeringdb-py config file. 
For information on how to add a scheduler task, see Scheduler. 


Customers who are not using a python virtual environment, or who are not running their local peeringdb database on the same server, should be able to set up their own cron task as outlined in the documentation below:
https://peeringdb.github.io/peeringdb-py/cli/#sync


View the Status:

Once set up, If the local database is reachable a green success message will display in Admin Settings → Peering Settings. 

Image Added

If the database fails to connect, a warning and error message will display instead:

Image Added

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:

...



ProVision versions 7.x and newer

...

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$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. 


...