Skip to content

Updating Docs with new logo and better architecture diagram #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@

![](tarmac-logo.png)

Build Serverless Microservices with WebAssembly Functions

[![PkgGoDev](https://pkg.go.dev/badge/github.com/madflojo/tarmac/pkg/sdk)](https://pkg.go.dev/github.com/madflojo/tarmac/pkg/sdk)
[![Documentation](https://img.shields.io/badge/docs-latest-blue)](https://tarmac.gitbook.io/tarmac/)
[![Build Status](https://github.com/madflojo/tarmac/actions/workflows/build.yml/badge.svg)](https://github.com/madflojo/tarmac/actions/workflows/build.yml)
[![Go Report Card](https://goreportcard.com/badge/github.com/madflojo/tarmac)](https://goreportcard.com/report/github.com/madflojo/tarmac)
[![Coverage Status](https://coveralls.io/repos/github/madflojo/tarmac/badge.svg?branch=master)](https://coveralls.io/github/madflojo/tarmac?branch=master)

Tarmac is a lightweight, open-source application server that simplifies building microservices using WebAssembly (WASM) functions. With Tarmac, you can quickly write and deploy a single function as a standalone microservice. Or you can use Tarmac's ability to run multi-function services to create a purpose-built serverless platform.
## Framework for writing functions, microservices, or monoliths with Web Assembly Functions

Tarmac is a new approach to application frameworks. Tarmac is language agnostic and offers built-in support for key/value stores like BoltDB, Redis, and Cassandra, traditional SQL databases like MySQL and Postgres, and fundamental capabilities like mutual TLS authentication and observability.

Tarmac delivers more than just a lightweight application server for WebAssembly functions. It offers built-in support for key-value stores like Redis and Cassandra, traditional SQL databases like MySQL and Postgres, and fundamental capabilities like mutual TLS authentication and observability. With Tarmac, you can easily focus on writing your functions while benefiting from a robust suite of integrations for building modern distributed services.
Supporting languages like Go, Rust, & Zig, you can focus on writing your functions in whatever language you like while benefiting from a robust suite of capabilities for building modern distributed services.

## Quick Start

Tarmac makes it easy to get started with building complex functions. This Go function is an excellent example of its simplicity. Its payload reversal logic leverages a key:value datastore for caching, demonstrating how effortless it is to create complex functionality with very little code.
Tarmac makes it easy to get started with building complex functions. The below function (written in Go) is an excellent example of its simplicity.

```go
// Tac is a small, simple Go program that is an example WASM module for Tarmac. This program will accept a Tarmac
Expand Down Expand Up @@ -98,7 +98,7 @@ That's it! You can write and deploy functions in Go, Rust, AssemblyScript, Swift

## Multi-Function Services

While users of Tarmac can build standalone microservices with a single function quickly, it shines with multi-function services. Tarmac's ability to run multiple functions means you can create purpose-built serverless platforms or full-featured distributed services with the developer experience of serverless functions.
While users of Tarmac can build standalone microservices with a single function quickly, it shines with multi-function services. Tarmac's ability to run multiple functions means you can create purpose-built platforms with the developer experience of serverless functions.

To get started with multi-function services, you must provide a `tarmac.json` configuration file (via the `WASM_FUNCTION_CONFIG` configuration parameter) that lists the Functions to load and the various protocols and routes to expose as endpoints. Below is a sample `tarmac.json` configuration file.

Expand Down Expand Up @@ -160,14 +160,16 @@ By leveraging waPC, WebAssembly Functions can interact with Tarmac's core capabi

To provide a streamlined developer experience, Tarmac offers a Go SDK that simplifies the usage of waPC. The SDK abstracts away the complexity of using waPC, allowing developers to focus on writing their functions and leveraging Tarmac's features.

With Tarmac, users can build a simple microservice (depicted below).

![Tarmac Single Function Architecture](tarmac-single-function.png)

Or, users can build complex Serverless platforms to enable multiple use cases.

![Tarmac Architecture](tarmac-architecture.png)

| Language | waPC Client | Tarmac SDK |
| :--- | :--- | :--- |
| AssemblyScript | ✅ | |
| Go | ✅ | ✅ |
| Rust | ✅ | |
| Swift | ✅ | |
| Zig | ✅ | |

## Contributing

We are thrilled that you are interested in contributing to Tarmac and helping to make it even better! To get started, please check out our contributing guide for information on how to submit bug reports, feature requests, and code contributions.
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

## Running Tarmac
* [Configuration](running-tarmac/configuration.md)
* [BoltDB](running-tarmac/boltdb.md)
* [Redis](running-tarmac/redis.md)
* [Cassandra](running-tarmac/cassandra.md)
* Datastores
Expand Down
2 changes: 2 additions & 0 deletions docs/running-tarmac/kvstore.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ The below table outlines the different available options.

| Datastore | Type option | Description | Useful for |
| -------- | ----------- | ----------- | ---------- |
| In-Memory | `in-memory` | In-Memory key/value store | Testing, Development, Non-Persistent Caching |
| BoltDB | `boltdb` | BoltDB Embedded key/value store | Strong Consistency, Persistent Storage |
| Redis | `redis` | Redis including Sentinel and Enterprise capabilities | Strong Consistency, Fast Reads and Writes, Non-Persistent storage |
| Cassandra | `cassandra` | Cassandra including TLS connectivity | Eventual Consistency, Persistent Storage, Large sets of data |

Expand Down
Binary file modified docs/tarmac-architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/tarmac-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
191 changes: 143 additions & 48 deletions docs/tarmac.drawio

Large diffs are not rendered by default.