Skip to content
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

Updating Architecture section of README #55

Merged
merged 2 commits into from
May 27, 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
15 changes: 6 additions & 9 deletions app/app_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -269,9 +269,8 @@ func TestRunningTLSServer(t *testing.T) {
cfg.Set("enable_tls", true)
cfg.Set("cert_file", "/tmp/cert")
cfg.Set("key_file", "/tmp/key")
cfg.Set("kvstore_type", "cassandra")
cfg.Set("cassandra_hosts", []string{"cassandra-primary", "cassandra"})
cfg.Set("cassandra_keyspace", "tarmac")
cfg.Set("kvstore_type", "redis")
cfg.Set("redis_server", "redis:6379")
cfg.Set("enable_kvstore", true)
cfg.Set("use_consul", false)
cfg.Set("listen_addr", "localhost:9000")
Expand Down Expand Up @@ -378,9 +377,8 @@ func TestRunningMTLSServer(t *testing.T) {
cfg.Set("cert_file", "/tmp/cert")
cfg.Set("ca_file", "/tmp/cert")
cfg.Set("key_file", "/tmp/key")
cfg.Set("kvstore_type", "cassandra")
cfg.Set("cassandra_hosts", []string{"cassandra-primary", "cassandra"})
cfg.Set("cassandra_keyspace", "tarmac")
cfg.Set("kvstore_type", "redis")
cfg.Set("redis_server", "redis:6379")
cfg.Set("enable_kvstore", true)
cfg.Set("use_consul", false)
cfg.Set("listen_addr", "localhost:9000")
Expand Down Expand Up @@ -482,10 +480,9 @@ func TestRunningFailMTLSServer(t *testing.T) {
cfg.Set("cert_file", "/tmp/cert")
cfg.Set("ca_file", "/tmp/cert")
cfg.Set("key_file", "/tmp/key")
cfg.Set("kvstore_type", "cassandra")
cfg.Set("cassandra_hosts", []string{"cassandra-primary", "cassandra"})
cfg.Set("cassandra_keyspace", "tarmac")
cfg.Set("enable_kvstore", true)
cfg.Set("kvstore_type", "redis")
cfg.Set("redis_server", "redis:6379")
cfg.Set("use_consul", false)
cfg.Set("listen_addr", "localhost:9000")
cfg.Set("config_watch_interval", 1)
Expand Down
18 changes: 17 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

![](tarmac-logo.png)

Write, Deploy and Scale Microservices with WebAssembly Functions
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/)
Expand Down Expand Up @@ -152,6 +152,22 @@ In addition to the `http` route type, Tarmac also supports `scheduled_task` rout

With Tarmac's support for multiple functions, you can quickly build complex, distributed services by dividing your service into smaller, more manageable pieces.

## Architecture

Tarmac is a serverless platform that enables users to define and execute WebAssembly Functions. When Tarmac receives requests, it forwards them to WebAssembly Functions, which act as request handlers. The communication between Tarmac and WebAssembly Functions is via WebAssembly Procedure Calls (waPC).

By leveraging waPC, WebAssembly Functions can interact with Tarmac's core capabilities. Capabilities include performing callbacks to the Tarmac server to access key-value stores, interact with SQL databases, or make HTTP requests to downstream services.

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)

## 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.
Binary file added 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 added docs/tarmac-single-function.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading