ISSUE #197: Provide a guide for running on k8s

Descriptions of the changes in this PR:

add one page for how to deploy on k8s. it is based on http://bookkeeper.apache.org/docs/latest/deployment/kubernetes/ and use distributedlog image and add instructions on how to create distributedlog namespaces and run benchmark.

This change is based on #196

Author: Sijie Guo <sijie@apache.org>

Reviewers: Jia Zhai <None>

This closes #198 from sijie/add_docker, closes #197
27 files changed
tree: da9ac08e3c767ea4c0bf99c66cd50ec057e0ad4e
  1. .github/
  2. deploy/
  3. distributedlog-benchmark/
  4. distributedlog-build-tools/
  5. distributedlog-common/
  6. distributedlog-core/
  7. distributedlog-core-twitter/
  8. distributedlog-dist/
  9. distributedlog-protocol/
  10. distributedlog-proxy-client/
  11. distributedlog-proxy-protocol/
  12. distributedlog-proxy-server/
  13. distributedlog-tutorials/
  14. docker/
  15. scripts/
  16. src/
  17. tests/
  18. vagrant/
  19. website/
  20. .gitignore
  21. .travis.yml
  22. ChangeLog
  23. LICENSE
  24. NOTICE
  25. pom.xml
  26. README.md
  27. Vagrantfile
README.md

logo

Build Status Build Status Coverage Status

Apache DistributedLog

Apache DistributedLog (DL) is a high-throughput, low-latency replicated log service, offering durability, replication and strong consistency as essentials for building reliable real-time applications.

Status

Apache DistributedLog project graduated from Incubator at July 2017. It is now a sub-project of Apache BookKeeper.

Features

High Performance

DL is able to provide milliseconds latency on durable writes with a large number of concurrent logs, and handle high volume reads and writes per second from thousands of clients.

Durable and Consistent

Messages are persisted on disk and replicated to store multiple copies to prevent data loss. They are guaranteed to be consistent among writers and readers in terms of strict ordering.

Efficient Fan-in and Fan-out

DL provides an efficient service layer that is optimized for running in a multi- tenant datacenter environment such as Mesos or Yarn. The service layer is able to support large scale writes (fan-in) and reads (fan-out).

Various Workloads

DL supports various workloads from latency-sensitive online transaction processing (OLTP) applications (e.g. WAL for distributed database and in-memory replicated state machines), real-time stream ingestion and computing, to analytical processing.

Multi Tenant

To support a large number of logs for multi-tenants, DL is designed for I/O isolation in real-world workloads.

Layered Architecture

DL has a modern layered architecture design, which separates the stateless service tier from the stateful storage tier. To support large scale writes (fan- in) and reads (fan-out), DL allows scaling storage independent of scaling CPU and memory.

First Steps

Next Steps

Get In Touch

Report a Bug

For filing bugs, suggesting improvements, or requesting new features, help us out by opening a jira.

Need Help?

Subscribe or mail the distributedlog-user@bookkeeper.apache.org list - Ask questions, find answers, and also help other users.

Subscribe or mail the distributedlog-dev@bookkeeper.apache.org list - Join developement discussions, propose new ideas and connect with contributors.

Join us on Slack - This is the most immediate way to connect with DistributedLog committers and contributors.

Contributing

We feel that a welcoming open community is important and welcome contributions.

Contributing Code

  1. See Developer Guide to get your local environment setup.

  2. Take a look at our open issues.

  3. Review our coding style and follow our code reviews to learn about our conventions.

  4. Make your changes according to our code review workflow.

  5. Checkout the list of project ideas to contribute more features or improvements.

Improving Website and Documentation

  1. See website/README.md on how to build the website.

  2. See docs/README.md on how to build the documentation.

About

Apache DistributedLog is an open source project of The Apache Software Foundation (ASF). The Apache DistributedLog project originated from Twitter.