From 99cd2f3a980a9b1bdf38f0d5cf893516f1ae3629 Mon Sep 17 00:00:00 2001 From: Al Cutter Date: Fri, 5 Jul 2024 13:28:11 +0100 Subject: [PATCH 1/5] Add README --- README.md | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..d4149283 --- /dev/null +++ b/README.md @@ -0,0 +1,73 @@ +# Trillian Tessera + +[![Slack Status](https://img.shields.io/badge/Slack-Chat-blue.svg)](https://transparency-dev.slack.com/) + +Trillian Tessera is a Go library for building tile-based transparency logs (tlogs). It is the logical successor to the approach Trillian v1 takes in building and operating logs. + +The implementation and its APIs bake-in current best-practices based on the lessons learned over the past decade of building and operating transparency logs in production environments and at scale. + +Tessera goals: + +* [Tiles-native API](https://github.com/C2SP/C2SP/blob/main/tlog-tiles.md) and storage +* Support for both cloud and on-premises infrastructure + * GCP and AWS support will be provided initially + * Cloud agnostic MySQL and POSIX filesystem support +* Make it easy to build and deploy new transparency logs on supported infrastructure + * Library instead of microservice architecture + * No additional services to manage + * Lower TCO for operators compared with Trillian v1 +* Fast sequencing and integration of entries +* Optional functionality which can be enabled for those ecosystems/logs which need it (only pay the cost for what you need): + * "Best-effort" de-duplication of entries + * Synchronous integration +* Broadly similar write-throughput and write-availability, and potentially _far_ higher read-throughput and read-availability compared to Trillian v1 (dependent on underlying infrastructure) +* Enable building of arbitrary log personalities, including support for the peculiarities of a [CT Tiles](https://github.com/C2SP/C2SP/blob/main/sunlight.md) compliant log. + +### Status + +Tessera is currently under active development, and is not yet ready for general use. However, early feedback is welcome. + +### Roadmap + +Alpha expected by Q4 2024. Link to Patrick’s magic kanban simulator. + +#### What’s happening to Trillian v1? + +[Trillian v1](https://github.com/google/trillian) is still in use in production environments by multiple organisations in multiple ecosystems, and is likely to remain so for the mid-term. + +_Forward looking statement:_ New ecosystems, or existing ecosystems looking to evolve, should strongly consider migrating to Tessera and adopting the patterns it encourages. + +### Getting started + +#### Usage + +```go + +import ( + + "[github.com/transparency-dev/trillian-tessera](http://github.com/transparency-dev/trillian-tessera)" + +) + +// TODO… + +``` + +### Contributing + +See [CONTRIBUTING.md](/CONTRIBUTING.md) for details. + +### License + +This repo is licensed under the Apache 2.0 license, see [LICENSE](/LICENSE) for details + +### Contact + +- Slack: https://transparency-dev.slack.com/ ([invitation](https://join.slack.com/t/transparency-dev/shared_invite/zt-27pkqo21d-okUFhur7YZ0rFoJVIOPznQ)) +- Mailing list: https://groups.google.com/forum/#!forum/trillian-transparency + + +### Acknowledgements + +Tessera builds upon the hard work, experience, and lessons from many _many_ folks involved in transparency ecosystems over the years. + From aa24853501915c790f902c75a842b7e8e3248843 Mon Sep 17 00:00:00 2001 From: Al Cutter Date: Fri, 5 Jul 2024 13:31:44 +0100 Subject: [PATCH 2/5] elide magic --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d4149283..4da37874 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Tessera is currently under active development, and is not yet ready for general ### Roadmap -Alpha expected by Q4 2024. Link to Patrick’s magic kanban simulator. +Alpha expected by Q4 2024. #### What’s happening to Trillian v1? From a588cab85da4914ae52c86e2d6b2530237165ce4 Mon Sep 17 00:00:00 2001 From: Al Cutter Date: Fri, 5 Jul 2024 13:36:50 +0100 Subject: [PATCH 3/5] forward looking --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4da37874..2d10152b 100644 --- a/README.md +++ b/README.md @@ -29,13 +29,13 @@ Tessera is currently under active development, and is not yet ready for general ### Roadmap -Alpha expected by Q4 2024. +Alpha expected by Q4 2024, and production ready in the first half of 2025. #### What’s happening to Trillian v1? [Trillian v1](https://github.com/google/trillian) is still in use in production environments by multiple organisations in multiple ecosystems, and is likely to remain so for the mid-term. -_Forward looking statement:_ New ecosystems, or existing ecosystems looking to evolve, should strongly consider migrating to Tessera and adopting the patterns it encourages. +New ecosystems, or existing ecosystems looking to evolve, should strongly consider planning a migration to Tessera and adopting the patterns it encourages. ### Getting started From 818abca449fbc9fc2c32364c7d23b36dd8b22fa4 Mon Sep 17 00:00:00 2001 From: Al Cutter Date: Fri, 5 Jul 2024 13:37:08 +0100 Subject: [PATCH 4/5] too much space --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 2d10152b..47179cfe 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Tessera goals: * "Best-effort" de-duplication of entries * Synchronous integration * Broadly similar write-throughput and write-availability, and potentially _far_ higher read-throughput and read-availability compared to Trillian v1 (dependent on underlying infrastructure) -* Enable building of arbitrary log personalities, including support for the peculiarities of a [CT Tiles](https://github.com/C2SP/C2SP/blob/main/sunlight.md) compliant log. +* Enable building of arbitrary log personalities, including support for the peculiarities of a [CT Tiles](https://github.com/C2SP/C2SP/blob/main/sunlight.md) compliant log. ### Status @@ -66,7 +66,6 @@ This repo is licensed under the Apache 2.0 license, see [LICENSE](/LICENSE) for - Slack: https://transparency-dev.slack.com/ ([invitation](https://join.slack.com/t/transparency-dev/shared_invite/zt-27pkqo21d-okUFhur7YZ0rFoJVIOPznQ)) - Mailing list: https://groups.google.com/forum/#!forum/trillian-transparency - ### Acknowledgements Tessera builds upon the hard work, experience, and lessons from many _many_ folks involved in transparency ecosystems over the years. From 6f097682a467df1d55c674ed8a35f825dd461d11 Mon Sep 17 00:00:00 2001 From: Al Cutter Date: Fri, 5 Jul 2024 15:05:53 +0100 Subject: [PATCH 5/5] Add link to tiles blog --- README.md | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 47179cfe..256bf5d5 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,17 @@ [![Slack Status](https://img.shields.io/badge/Slack-Chat-blue.svg)](https://transparency-dev.slack.com/) -Trillian Tessera is a Go library for building tile-based transparency logs (tlogs). It is the logical successor to the approach Trillian v1 takes in building and operating logs. +Trillian Tessera is a Go library for building +[tile-based transparency logs (tlogs)](https://github.com/C2SP/C2SP/blob/main/tlog-tiles.md). +It is the logical successor to the approach Trillian v1 takes in building and operating logs. -The implementation and its APIs bake-in current best-practices based on the lessons learned over the past decade of building and operating transparency logs in production environments and at scale. +The implementation and its APIs bake-in +[current best-practices based on the lessons learned](https://transparency.dev/articles/tile-based-logs/) +over the past decade of building and operating transparency logs in production environments and at scale. Tessera goals: -* [Tiles-native API](https://github.com/C2SP/C2SP/blob/main/tlog-tiles.md) and storage +* [Tiles-native API](https://github.com/C2SP/C2SP/blob/main/tlog-tiles.md) and storage * Support for both cloud and on-premises infrastructure * GCP and AWS support will be provided initially * Cloud agnostic MySQL and POSIX filesystem support @@ -20,12 +24,15 @@ Tessera goals: * Optional functionality which can be enabled for those ecosystems/logs which need it (only pay the cost for what you need): * "Best-effort" de-duplication of entries * Synchronous integration -* Broadly similar write-throughput and write-availability, and potentially _far_ higher read-throughput and read-availability compared to Trillian v1 (dependent on underlying infrastructure) -* Enable building of arbitrary log personalities, including support for the peculiarities of a [CT Tiles](https://github.com/C2SP/C2SP/blob/main/sunlight.md) compliant log. +* Broadly similar write-throughput and write-availability, and potentially _far_ higher read-throughput + and read-availability compared to Trillian v1 (dependent on underlying infrastructure) +* Enable building of arbitrary log personalities, including support for the peculiarities of a + [CT Tiles](https://github.com/C2SP/C2SP/blob/main/sunlight.md) compliant log. ### Status -Tessera is currently under active development, and is not yet ready for general use. However, early feedback is welcome. +Tessera is currently under active development, and is not yet ready for general use. However, early +feedback is welcome. ### Roadmap @@ -33,9 +40,11 @@ Alpha expected by Q4 2024, and production ready in the first half of 2025. #### What’s happening to Trillian v1? -[Trillian v1](https://github.com/google/trillian) is still in use in production environments by multiple organisations in multiple ecosystems, and is likely to remain so for the mid-term. +[Trillian v1](https://github.com/google/trillian) is still in use in production environments by +multiple organisations in multiple ecosystems, and is likely to remain so for the mid-term. -New ecosystems, or existing ecosystems looking to evolve, should strongly consider planning a migration to Tessera and adopting the patterns it encourages. +New ecosystems, or existing ecosystems looking to evolve, should strongly consider planning a +migration to Tessera and adopting the patterns it encourages. ### Getting started @@ -68,5 +77,6 @@ This repo is licensed under the Apache 2.0 license, see [LICENSE](/LICENSE) for ### Acknowledgements -Tessera builds upon the hard work, experience, and lessons from many _many_ folks involved in transparency ecosystems over the years. +Tessera builds upon the hard work, experience, and lessons from many _many_ folks involved in +transparency ecosystems over the years.