Skip to content

Observatory ProtocolOpen developmentTake part

How to take part

Who takes part, in which role, through which gateway, and the path from learning the protocol to claiming conformance.

Version
0.1.0-draft
Status
Draft specification
Specification
CC BY 4.0
Code
Apache-2.0
Steward
GCRI Canada
Source
obsp-0.1-foundation

Roles

Participation roles of the protocol. They are not the runtime roles of the specification.

Observer
Read every draft, register and decision; attend open sessions; comment in comment windows.
Contributor
Open issues and OIPs, submit fixtures, conformance cases, code and translations. Requires · contribution-terms
Implementer
Build a node agent, site cell, grid service, provider or consumer and claim a conformance profile. Requires · contribution-terms
Operator
Run a conforming deployment in its own environment, with its own keys, identity, updates and telemetry.
Provider
Supply hardware, software, connectivity, data, models or services behind the typed contracts, under admission. Requires · admission
Consumer
Use governed products through the exchange plane under the operator's terms.

The path

From learning the protocol to claiming conformance. Registration is optional.

  1. Learn

    Read the primer and the specification; follow the Risk Academy module for the protocol.

  2. Register (optional)

    Register the organisation as a participant with a participant manifest. Nothing in the protocol requires it.

  3. Choose profiles and an environment

    Pick conformance profiles (§7), the sovereignty overlay (§12) and an environment of the deployment matrix (§13).

  4. Build or deploy

    Implement or deploy against the schemas, field topics, protobuf and gateway API; use the SDK and fixtures.

  5. Test

    Run the conformance suite on your evidence and keep the report.

  6. Claim

    Publish a conformance claim with the report and the digests of the tested artifacts.

  7. Contribute back

    Report gaps, propose OIPs, offer test vectors, share evidence with Nexus Reports and teaching material with Risk Academy.

Who takes part

Participant classes, the roles each takes and the profiles each typically claims.

ClassRolesProfiles
National governments and their agenciesOBSERVER CONTRIBUTOR OPERATOR CONSUMEROBSP-SITE OBSP-GRID OBSP-CONSUMER
Provinces, states, regions, municipalities and utilitiesOBSERVER CONTRIBUTOR OPERATOR CONSUMEROBSP-SITE OBSP-GRID OBSP-CONSUMER
United Nations agencies and other intergovernmental organisationsOBSERVER CONTRIBUTOR OPERATOR CONSUMEROBSP-GRID OBSP-CONSUMER
National consortiums, national standards councils and national hostsOBSERVER CONTRIBUTOR OPERATOR CONSUMEROBSP-SITE OBSP-GRID OBSP-CONSUMER
Non-profits, foundations and humanitarian organisationsOBSERVER CONTRIBUTOR OPERATOR CONSUMEROBSP-SITE OBSP-CONSUMER
Enterprises and infrastructure ownersOBSERVER CONTRIBUTOR IMPLEMENTER OPERATOR PROVIDER CONSUMEROBSP-SITE OBSP-GRID OBSP-PROVIDER OBSP-CONSUMER
Device makers (instruments, sensors, gateways, radios, edge computers)OBSERVER CONTRIBUTOR IMPLEMENTER PROVIDEROBSP-NODE OBSP-PROVIDER
Universities, observatories and research networksOBSERVER CONTRIBUTOR IMPLEMENTER OPERATOR CONSUMEROBSP-NODE OBSP-SITE OBSP-CONSUMER
Community and citizen networksOBSERVER CONTRIBUTOR OPERATOR CONSUMEROBSP-NODE OBSP-SITE OBSP-CONSUMER
Managed-service and technology providers operating for an ownerOBSERVER CONTRIBUTOR IMPLEMENTER PROVIDEROBSP-GRID OBSP-PROVIDER
Individual experts, developers, students and members of the publicOBSERVER CONTRIBUTOR IMPLEMENTER

Gateways

The doors through which a contribution reaches the body that handles it.

GatewayTakesRoutes to
This repositoryquestion issue oip comment test-vector code-contribution translationEDITORS
Conformance claims (pull request to IMPLEMENTATIONS.md, or the gateway API)conformance-claim test-vectorCONFORMANCE
Gateway API of a conforming deployment (join, admit, describe, registers, claims)participant-registration conformance-claimOPERATOR
Private vulnerability reportingvulnerabilitySECURITY
Nexus Standards sitecomment issue oip translation national-adoption-interest liaison-requestSECRETARIAT
GCRI Canada sitesquestion issue test-vector participant-registration national-adoption-interestSECRETARIAT
The Global Risks Forum sitescomment participant-registration national-adoption-interest liaison-requestSECRETARIAT
The Global Risks Alliance sitescomment participant-registration liaison-requestSECRETARIAT
Risk Academylearning-feedback translation comment questionSECRETARIAT
Nexus Reports contribution gatewayreport-evidence commentSECRETARIAT
Nexus Universeparticipant-registration comment test-vectorSECRETARIAT
Commons room of each Foundry systemcomment issue test-vector code-contributionEDITORS
Council room (nexus.council) in the Foundrycomment liaison-requestSECRETARIAT

The protocol repository did not answer anonymous requests when this page was generated. Until it opens, use the forms below.

Participation

How anyone takes part, free of charge, through the gateways in registers/gateways.yaml. (Observatory Protocol policy, Participation)

PAR-1
Anyone may observe, comment and contribute, free of charge. No fee, membership or registration is needed to read, implement or claim conformance.
PAR-2
Every contribution is acknowledged within 2 working days, triaged within 10 and given a recorded disposition within 45.
PAR-3
Contributors confirm the right to contribute with a Developer Certificate of Origin sign-off on each commit.
PAR-4
Participants declare interests that bear on the work they review or decide.
PAR-5
Participation follows the code of conduct (CODE_OF_CONDUCT.md).
PAR-6
A participant registration is organisation-level and carries no personal data beyond a contact role.

Contributing

Before you start, making a change, and the rules that keep the protocol neutral. (Observatory Protocol, Contributing)

Everyone is welcome, free of charge. Choose your route in docs/participants/.

Before you start

  • Read the primer, the specification, GOVERNANCE.md and the code of conduct.
  • Questions and defects go in an issue. Protocol changes go in an OIP. Vulnerabilities are reported privately (SECURITY.md).

Making a change

  1. For a protocol change, copy oips/0000-template.md to oips/NNNN-short-title.md.
  2. Change everything the rule touches in the same pull request:
  3. the specification;
  4. the schemas, with a negative fixture for every new rule (_expectedFailure says why);
  5. the conformance cases;
  6. the registers;
  7. CHANGELOG.md.
  8. Policies change only in registers/policies.yaml. Then run python3 tools/build_policies.py.
  9. Sign off every commit (git commit -s, Developer Certificate of Origin, PAR-3).
  10. Run make check before you push. CI runs the same checks plus protobuf compilation, the SDK tests, the conformance examples, the secret scan and the reproducibility check.

Rules that keep the protocol neutral and usable by every operator

  • The specification, contracts and registers name roles, never organisations, products, vendors or endpoints (NEU-1). The governance and ecosystem documents name the Consortium institutions and systems in their roles.
  • Missing data is a typed state, never zero (DAT-3).
  • Status words describe evidence only. Nothing is written as a certification (CNF-1).
  • Never reuse an identifier, rule id or schema id for another meaning (DEP-3).

Across the consortium

Related pages on the consortium's other networks, in their own words.

StandardsNexus Standards
Open standards to identify, describe, verify and cite risk information, which observations bound by the protocol can carry.nexustandards.com
IndexThe Global Risks Index
Country risk indicators that observations with provenance and quality can inform.risksindex.com
AcademyRisk Academy
Training for implementers and operators of observing systems.risksacademy.com
ReportsReports at Nexus Standards
Published evidence with provenance, citation and corrections.nexustandards.com/nexus-reports

References

Sources cited on this page, in order of first citation. Addresses were last checked on the date shown.

  1. Observatory Protocol policy, Participation: registers/policies.yaml participation Observatory Protocol 0.1 (draft), CC BY 4.0.
  2. Observatory Protocol, Contributing: CONTRIBUTING.md Observatory Protocol 0.1 (draft), CC BY 4.0.