Skip to content
duglinPublic
forked from xregistry/server

About

Reference Implementation of xRegistry Server

Resources

Stars

0 stars

Watchers

0 watching

Forks

 
 

Repository files navigation

CI FOSSA Status

xRegistry

xRegistry Implementation

A full implementation of the xRegistry specification, providing a metadata registry for discovering, validating, and versioning resources in distributed systems. This also includes a CLI (xr) that can be used to manage data in Registries.

Note: This project is a work-in-progress. See the todo list for upcoming features or report issues if you encounter problems.

Where to go from here...

Implementation Details/Choices

See the Design Doc

Storage Backends

  • mysql (default): persistent storage in a MySQL database.
  • memory: pure in-memory storage, nothing is persisted. It has no notion of DBs (xrserver db ... returns an error and --recreatedb is a no-op) and everything is lost when the process exits. Useful for quick demos and for running tests without MySQL.

Select a backend with xrserver --backend memory, the XR_BACKEND environment variable, or the backend config property. To run the test suite against the memory backend (no MySQL needed): make mtest.

Backend options are set with the same syntax: --backend [NAME,]OPT=VALUE,... (e.g. --backend mysql,host=db1,port=3307,dbname=foo), XR_BACKEND, or in the config file as backend.<name>.<option> (e.g. backend.mysql.host: db1). If the name is omitted then the options apply to the current backend. The flag can be repeated, and a comma in a value can be escaped as \,. Run xrserver backend list [-o json] to see the backends and their options. XR_BACKEND_SECRET is parsed like XR_BACKEND, after it, but isn't shown when env vars are dumped (e.g. by misc/start), so use it for passwords.

About

Reference Implementation of xRegistry Server

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages