README.md

autonode

Autonode Register and Measure

After a hosting organization registers with M-Lab, their autonodes will:

1. Register with the Autojoin API
2. Distribute credentials & metadata to local services
3. Report node health to the Locate API
4. Clients run NDT tests targeting this node
5. NDT measurements are archived
6. NDT measurements published to BigQuery

Host Portals

Host organizations can create test portals that target their servers.

Create a copy of ndt7-js client example. Modify metadata to include the request parameters for your organization or server.

For example:

    ...
    metadata: {
        client_name: 'foo-ndt7-org-portal',
        org: 'foo',
    },
    ...

A portal can enumerate all known sites for an organization, using the Autojoin.List parameters:

• https://autojoin.measurementlab.net/autojoin/v0/node/list?format=sites&org=foo

    ...
    metadata: {
        client_name: 'foo-ndt7-site-portal',
        site: 'bar12345',
    },
    ...