Overlock is a secure, transparent, and decentralized Control Planes marketplace that connects those who need ready to use Crossplane or ArgoCD Control Planes (tenants) with those that have required Control Plane capacity to lease (providers).
For a high-level overview of the Overlock protocol and network economics, check out the whitepaper; a detailed protocol definition can be found in the design documentation; and the target workload definition spec is here.
The main branch contains new features and is under active development; the mainnet/main branch contains the current, stable release.
- stable releases will have even minor numbers (
v0.0.28) and be cut from themainnet/mainbranch. - unstable releases will have odd minor numbers (
v0.0.28) and be cut from themainbranch.
Overlock Suite is the reference implementation of the Overlock Protocol. Overlock is an actively-developed prototype currently focused on the distributed marketplace functionality.
The Suite is composed of one binary, overlock, which contains a (tendermint-powered) blockchain node that
implements the decentralized exchange as well as client functionality to access the exchange and network data in general.
The easiest way to get started with Overlock is by following the Quick Start Guide to get started.
| Platform | Arch | Status |
|---|---|---|
| Darwin | amd64 | ✅ Supported |
| Linux | amd64 | ✅ Supported |
| Windows | amd64 |
curl -sSfL https://raw.githubusercontent.com/overlock-network/node/main/install.sh | shOr install a specific version with GoDownloader
curl -sSfL https://raw.githubusercontent.com/overlock-network/node/main/install | sh -s -- 0.0.37Overlock is written in Golang and is Apache 2.0 licensed - contributions are welcomed whether that means providing feedback, testing existing and new feature or hacking on the source.
To become a contributor, please see the guide on contributing
This doc guides through setting up local development environment
Overlock is developed and tested with golang 1.24.0+.
Building requires a working golang installation, a properly set GOPATH, and $GOPATH/bin present in $PATH.
It is also required to have C/C++ compiler installed (gcc/clang) as there are C dependencies in use (libusb/libhid)
Overlock build process and examples are heavily tied to Makefile.
Command below will compile overlock executable and put it into .cache/bin
make # overlock is set as default target thus `make` is equal to `make overlock`once binary compiled it exempts system-wide installed overlock within overlock repo
We use thin integration testing environments to simplify the development and testing process. We currently have three environments:
- Single node: simple (no workloads) single node running locally.