README
¶
RTC
DISCLAIMER: The project is currently in WIP state. Maybe isn't yet good time to contribute due things will keep moving around all the time.
Overview
RTC is a framework to call remote transactions over multiple services.
It focuses on be:
-
Centralized: transactions will be executed following a unique pipeline.
-
Language agnostic: providing APIs over HTTP / gRPC / CLI to use it and also config via YAML files.
-
No-protocol limited: protocols of services are not a limitation at the hour of integrating any of them. For more, see the list of supported protocols.
-
Simple: to ensure simplicity over differences across services and provide a normalized way to interact with data pipelines, it uses git abstractions and a schema.
-
No ownership needed: the services to be used are all treated as foreign ones, so there isn't a client-side on any RTC callable service. You call it by its own interface.
Purpose
The original and minimal purpose is to forget SDKs. That means, removing:
-
Huge amount of dependencies when connecting multiple services.
-
Maintainability of the SDK itself.
-
Reliability on
nevernot always tested software. -
Lock of the mainstream-only technology stack.
The second one is to improve the understanding and knowledge of external data structures.
It comes from the Rob Pike's rule:
Data dominates. If you've chosen the right data structures and organized things well, the algorithms will almost always be self-evident. Data structures, not algorithms, are central to programming.
Its very harmful (and then, a frequent mistake) to choose bad data structures by misunderstanding the external structures in which your act will depend on.
Usage
In case you use Go, its recommendable to inspect the godoc for a complete usage guide omitting the usage of an API.
Concepts
Schema
A schema describes the data structure of a callable transactional service. The definition of it can be served across HTTPs (k8s like) or over a filesystem via YAML. For more, see the Schema reference.
It also has its own structure. Formed by a tiny sql abstraction:
-
Blueprint: the group of tables a schema contains. It just describes all the structure, but it doesn't relate it.
-
Tables: sql-like concept. It describes a collection of abstractions that are described by the same columns.
-
Columns: sql-like concept. It holds a specific type of data (type-safe) and describes a field over an entity.
- Type: limits the type a column can have.
-
Option: just a key-value storage used to pass extra information about the transaction that can't be expressed through columns of an entity (e.g: scopes).
- Option key: limits the possible key of the storage.
Git
RTC provides git-like abstractions to avoid a high cognitive load.
Currently, those are:
-
Change: a change of value on a column of a table. It can be a deletion or addition.
-
Commit: a group of changes signed (ensuring persistence).
-
Branch: a parallel context instantiation for communicating via multiple actors. It contains an index and multiple commits. For practical purposes, it stores all the credentials for the services it'll communicate.
-
Index: it contains the group of changes that weren't committed and were done over the branch it belongs to.
-
Collaborator: it's responsible for communicating with a specific service using its own interface. It can push, pull, delete and init.
-
Member: a collaborator assigned to a table.
-
Team: a group of members assigned to a schema.
-
Community: a group of teams that are available to collaborate.
-
Project: a group of schemas.
-
Owner: it's responsible for orchestrating its own project given a community. It's a collaborator too.
-
Pull request: a group of commits performed by a team.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package config provides configuration and env vars handling
|
Package config provides configuration and env vars handling |
|
Package fabric provides an easy way to create native struct receiver types given a schema
|
Package fabric provides an easy way to create native struct receiver types given a schema |
|
Package git contains the management of changes' pipelines as git abstractions It's the main actor on performing CRUD actions over remote
|
Package git contains the management of changes' pipelines as git abstractions It's the main actor on performing CRUD actions over remote |
|
Package integrity provides types to reduce API usage difficulty and avoid ambiguous args by type system
|
Package integrity provides types to reduce API usage difficulty and avoid ambiguous args by type system |
|
internal
|
|
|
name
Package name contains the naming conventions on rtc
|
Package name contains the naming conventions on rtc |
|
store
Package store contains the abstractions and handlers to deal with the store (DB)
|
Package store contains the abstractions and handlers to deal with the store (DB) |
|
test/assist
Package assist contains testing helpers but for initialization.
|
Package assist contains testing helpers but for initialization. |
|
test/thelper
Package thelper contains testing helpers.
|
Package thelper contains testing helpers. |
|
xerrors
Package xerrors contains the custom error types of rtc
|
Package xerrors contains the custom error types of rtc |
|
Package literals provides ready-to-use abstractions to implement literals easier
|
Package literals provides ready-to-use abstractions to implement literals easier |
|
github
Package github provides ready-to-use literals for GitHub REST API
|
Package github provides ready-to-use literals for GitHub REST API |
|
Package msh provides general marshal utilities, including custom Decoders/Encoders
|
Package msh provides general marshal utilities, including custom Decoders/Encoders |
|
Package schema is the main package of the schema definition It is responsible for creating a structure over the data, and pretends to perform validations before having to communicate
|
Package schema is the main package of the schema definition It is responsible for creating a structure over the data, and pretends to perform validations before having to communicate |
|
valide
Package valide provides validator funcs to check types of an type-unsafe value
|
Package valide provides validator funcs to check types of an type-unsafe value |
|
Package server provides HTTP server related things
|
Package server provides HTTP server related things |