README
¶
Fertile Soil
Status
Summary
It's what needed for healthy trees to grow in.
Fertile Soil is a framework to build platforms with. It builds upon the concept of a tree (a directory structure) which is the basis of a multi-tenant platform.
It provides a tree representation, as well as the backend to store it in a database. It also provides an HTTP API to access the tree.
For more information on multi-tenancy, view the Multi-Tenancy doc.
The Tree(s)
The overall model is as follows:
Since the intent is to build multi-tenant platforms, what is a platform without applications? In this model, everything is scoped to the tree, and thus applications are meant to be scoped to specific nodes.
The intention is to build a bunch of micro-services that would call the tree manager to get the tree for a given tenant, and then use that tree to determine what to do.
What's provided?
The tree manager provides the following:
- A directory tree representation
- A storage system to store the tree in a database
- APIs to access and manage the tree
What's not provided?
The tree manager does not provide the following:
- A way to authenticate users
- A way to authorize users
- A way to manage users
- A way to manage applications
- Resources for applications
All of these are application-specific and are not provided by the tree manager.
Components
API
The API defines the structures that both the client, server and storage system use.
In order to accommodate to changing requirements and needs, the API is kept simple and only defines the structures that are needed to build the platform.
The main structures are located in api/v1/directory.go
Storage System
The storage system contains the implementation details of how the tree is stored in the database.
Currently, the only implementation is using CockroachDB, but the intention is to allow for other implementations to be used.
Any storage implementation needs to implement the storage.Storage interface.
Since the access pattern is read-heavy, the storage system needs to be optimized for that.
Notification System
The notification system is used to notify applications of changes to the tree.
Given that applications wouldn't have direct access to the database, it is up to the individual applications to subscribe to the notification system to know if a child node has been added or removed and update their internal state accordingly.
Any notification system needs to implement the notification.Notifier
interface.
Tree Manager
A sample server implementation is provided in as the treeman command that's built
as part of this project.
Tree Client
A client library that can be used to access the tree manager is provided.
Applications
In this model, nothing is special about applications. They are all expected to just scoped to a specific node in the tree. The tree manager provides the APIs to access the tree, and the applications are expected to use that to determine what to do.
Thus, any notion of a global resource or application is not provided by the tree manager nor encouraged.
For a more detailed descriptions on the components or applications that are to be built for this platform, view the Applications doc.
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
app
|
|
|
v1/sql/migrations
Package migrations provides helpers for building client applications that use a SQL database.
|
Package migrations provides helpers for building client applications that use a SQL database. |
|
client
|
|
|
internal
|
|
|
crdb/migrations
Package db provides an embedded filesystem containing all the database migrations
|
Package db provides an embedded filesystem containing all the database migrations |
|
memory
Package memory implements a memory storage backend for the fertilesoil storage interface.
|
Package memory implements a memory storage backend for the fertilesoil storage interface. |
|
tests
|
|