Marble-node-registry

The purpose of this repository is to serve as a single source of truth for information on all Marble nodes that constitute the Marble network at any time. Active Marble nodes will periodically retrieve this file and update their own local databases with the information contained within it.

Access the registry

The registry can be accessed at the following URL:

https://raw.githubusercontent.com/DACCS-Climate/Marble-node-registry/current-registry/node_registry.json

The registry is a JSON string that contains information about all nodes in the Marble network. This file is regularly updated so that the information provided is up-to-date.

Add or update information about a Marble node

This repo is only meant to be updated by administrators who either (i) manage Marble nodes or, (ii) want to deploy a new Marble Node.

If you want to deploy a new Marble Node and connect it to the Marble network (connecting a node to the Marble network is what makes a node a Marble node), then fork this repo and edit the node_registry.json file with information about the base URL at which your node can be accessed. Then, please submit a pull request with your changes. The DACCS (Data Analytics for Canadian Climate Services) Executive Committee (the DACCS project manages the Marble network) will review the request to determine whether-or-not to allow your node to become a part of the network. Updating this repo is typically the last step in the journey for a node to federate with the network and ideally before getting to this point, you are already in conversations with the DACCS Executive Committee about your plans on being a part of the network.

If you are already part of the Marble Network and details about your node have changed (e.g. url, contact email, etc.). In which case, please submit the pull request with the new URL and the Executive Committee will approve it quickly.

When making changes to the node_registry.json file please only change or add the following values:

• name (the name of your node, to be displayed to users)
• affiliation (the name of your organization, optional)
• description (a short description of your node, optional)
• location (latitude and longitude of your organization, optional)
• contact (an email address that can be used by users to contact you if they have questions about your node)
• registration_status (indicates whether the node is currently accepting new users or not)
  • values must be one of:
    • open: accepting new registration requests
    • limited: accepting new registrations under limited circumstances
    • closed: not accepting new registration requests
• links (contains a list of link objects that describe URLs for each node)
  • each link object must contain a rel and href key.
  • some link objects are required, see the table below for details

The top level keys in the node_registry.json file cannot be modified once they have been set. These keys are used as a unique identifier of your node in the network and will cause problems for node interoperability if changed.

See the node_registry.example.json file for example values.

Links

The links key should contain links that describe and provide access to your node. Please see the table below for a description of some link values that may be useful.

rel	Meaning	Required
about	link to a summary or purpose of the node
author	link to the website of the maintainer/institution of the node
acl	link to an Access Control List endpoint, such as /magpie
collection	link to the /services endpoint of the node	Yes
cite-as publication	link to attribution/citation information for use when referencing the node in publications
copyright license terms-of-service	link to legal information of the node
describedby	link to full documentation and details of the node, its purpose and so on
edit	A self-reference to this repo or anywhere a user can request an update to a node
registration	link to a page or email address where a new user can request an account
service	link to the landing page of the node	Yes
service-desc	link to the /components endpoint of the node
icon	link to the logo of the specific node (or the maintainer/institution's logo)
status	link to a monitoring service endpoint, such as /canarie
version	link to the /version endpoint of the node	Yes
version-history	link to https://github.com/bird-house/birdhouse-deploy/blob/master/CHANGES.md or similar

Admin instructions

Additional instructions for managing this repo (for admins only) can be found here.

Testing

To run unittests contained in the tests/ directory:

pip install -r requirements.txt -r tests/requirements.txt
pytest ./tests