OpAMP Specification

This repository contains Open Agent Management Protocol (OpAMP) specification and Protobuf definitions in proto directory.

See releases here and changelog here.

Contributing

Prerequisites:

NodeJS/NPM CLI

The specification is a single markdown file. If you make changes to the section headings make sure to update the Table of Contents by running make markdown-toc in root directory.

If any changes are made to Protobuf message definitions in the specification.md make sure to update also the *.proto files in the proto directory. Run make gen-proto to run the Protobuf compiler and verify the *.proto files.

Proposal Requirements

Proposals to add new capabilities to the OpAMP specification must be accompanied by working prototypes in opamp-go, demonstrating the capability. The prototype can be a PR against opamp-go or can be on your own fork of opamp-go. The prototype will be used to help aid maintainers in understanding the implications of the specification changes and how actual usage might look.

To make a proposal, create a PR in this repo that modifies the specification markdown and the Protobuf files and include a link to the prototype in the description. We advise you to attend the OpAMP SIG meeting and discuss your proposal before you spend effort on it to make sure the proposal is aligned with the SIG's vision.

All new capabilities must be added in Development maturity level initially. Make sure to add the [Development] status label in the specification markdown and as a prefix of the added proto field or message.