Template for a von-x based agent
Branch: master
Clone or download
Latest commit 6f148bd Feb 8, 2019

README.md

License

von-agent-template

This repo is a template for creating an instance of the Verifiable Organizations Network (VON) Issuer/Verifier Agent running against a Hyperledger Indy network such as Sovrin.

von-agent-template is being developed as part of the VON. For more information on VON, see https://vonx.io. Even better, join in with what we are doing and contribute to VON and the Indy community.

A VON Issuer/Verifier Agent (see examples in dFlow) and OrgBook are the two major components of a local VON ecosystem. OrgBook is an instance of a credential repository from which a VON Issuer/Verifier Agent instance receives proofs of verifiable claims and to which a VON Issuer/Verifier Agent issues verifiable credentials. VON Issuer/Verifier Agent instances are configured, deployed and operated by registration, permit and licence issuing service organizations that want to issue or verify verifiable credentials. One VON Issuer/Verifier Agent instance can support multiple types of credentials and in most cases, an organization would only need to run a single agent to process all credential types they need. An agent based on this template is deployed using containers, enabling load balancing and high availability capabilities through a container management platform such as Red Hat's OpenShift, Kubernetes on AWS, Azure or Google Cloud, etc.

In the future, instances of VON Issuer/Verifier Agent will also be able to communicate directly with personal and organizational agents or wallets and will be able to issue and/or verify credentials based on different underlying DID-method implementations.

Getting Started

Use this VON Issuer/Verifier Getting Started Tutorial to go through the basics of configuring a VON Issuer/Verifier Agent created from this template.

Configuration Guide

Much of the work in configuring a VON Issuer/Verifier Agent is in setting up the YAML files in the von-x-agent/config folder. A Configuration Guide documents those files.

Managing Your Agent Repo

If you are creating an agent for a service organization that will become a VON Issuer/Verifier Agent, most of the changes you will make in this repo will be for your own organization's use and will not be pushed back into the base repo. As such, we suggest you use one of following methods for managing this repo. We recommend the first method, but would welcome suggestions of other approaches that might have more upside and less downside. Please add an issue to tell us about a better way.

  1. Make a snapshot (not a fork or clone - a text copy) of this repo to use as the base repo for your organization's agent from there. The benefit of that approach is that your developers can fork the snapshot repo and manage everything through the common GitHub Pull Request (PR) model. The downside is that periodically you should look for code updates to this (von-agent-template) repo and apply them to your copy. There are relatively easy ways to track such changes, such as keeping a fork of von-agent-template, using GitHub's compare capability to find the differences and apply them to your snapshot repo.

  2. Make a fork of this repo, and in that, create a branch that you will use as the deployment branch for your agent instance. The benefit of this approach is that you can stay up-to-date with the base repo by applying commits to your branch from the master. The downside is a much more complex branching model for your developers and a non-typical deployment model for your code.

In theory, the two mechanisms above can be combined, and branches could be created in the main repo for the different agent instances. This might be an approach that, for example, the BC Gov could use—creating a branch for each VON Issuer/Verifier Agent in BC Gov. However, we think that the benefits of such a scheme is not worth the complexity.

Getting Help or Reporting an Issue

To report bugs/issues/feature requests, please file an issue.

How to Contribute

If you have found this project helpful, please contribute back to the project as you find new and better ways to use SonarQube in your projects.

If you would like to contribute, please see our CONTRIBUTING guidelines.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.