From b1bc76463834fe10f8a1007cf18c2d89bad11372 Mon Sep 17 00:00:00 2001 From: Ivan Blinkov Date: Wed, 15 May 2024 02:18:14 -0700 Subject: [PATCH] Update README.md (#4534) --- README.md | 56 +++++++++++++++++++++++++------------------------------ 1 file changed, 25 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index fcc4be75f28d..b7637c6c423a 100644 --- a/README.md +++ b/README.md @@ -22,73 +22,67 @@ YDB is an open source Distributed SQL Database that combines high availability a ## Main YDB Advantages -YDB is designed from scratch as a response to growing demand for scalable interactive web services. Scalability, strict consistency and effective cross-row transactions were a must for such OLTP-like workload. YDB is built by people with strong background in databases and distributed systems, who had an experience of developing No-SQL database and the Map-Reduce system for one of the largest search engines in the world. -We found that YDB's flexible design allows us to build more services on top of it including persistent queues and virtual block devices. +YDB was designed from scratch to respond to the growing demand for scalable interactive web services. Scalability, strict consistency, and effective cross-row transactions were a must for such an OLTP-like workload. YDB was built by people with strong backgrounds in databases and distributed systems who have experience developing a NoSQL database and the MapReduce system for one of the largest search engines in the world. Basic YDB features: - - Fault-tolerant configuration that survive disk, node, rack or even datacenter outage; - - Horizontal scalability; - - Automatic disaster recovery with minimum latency disruptions for applications; - - SQL dialect (YQL) for data manipulation and scheme definition; - - ACID transactions across multiple nodes and tables with strict consistency. +- Both row-oriented and column-oriented [tables](https://ydb.tech/docs/en/concepts/datamodel/table) for transactional and analytical workloads. Also, [persistent queues (topics)](https://ydb.tech/docs/en/concepts/topic) for moving data around. +- Fault-tolerant configuration that survives disk, node, rack, or even datacenter outages. +- Automatic disaster recovery with minimum latency disruptions for applications. +- Independent horizontal scalability of storage and compute layers. +- ACID transactions across multiple nodes and tables with strict consistency. +- Rich [SQL dialect (YQL)](https://ydb.tech/docs/en/yql/reference/) for data manipulation and schema definition. +- [PostgreSQL-compatible mode](https://ydb.tech/docs/en/postgresql/intro) for table operations and [Kafka-compatible mode](https://ydb.tech/docs/en/reference/kafka-api/) for topics. +- YDB clusters can be deployed with [Ansible](https://ydb.tech/docs/en/devops/ansible/), [Kubernetes](https://ydb.tech/docs/en/devops/kubernetes/), or [manually](https://ydb.tech/docs/en/devops/manual/). ### Fault-tolerant Configurations -YDB could be deployed in three availability zones. Cluster remains available for both reads and writes during complete outage of a single zone. Availability zones and regions are covered in more detail [in documentation](https://ydb.tech/en/docs/concepts/databases#regions-az). +YDB can be deployed in three availability zones (datacenters). A cluster remains available for both reads and writes during a complete outage of a single zone. Availability zones and regions are covered in more detail [in documentation](https://ydb.tech/en/docs/concepts/databases#regions-az). ### Horizontal Scalability -Unlike traditional relational databases YDB [scales out](https://en.wikipedia.org/wiki/Scalability#Horizontal_or_scale_out) providing developers with capability to simply extend cluster with computation or storage resources to handle increasing load. YDB has desaggregated storage and compute layers which allow you to scale storage and compute resources independently. +Unlike traditional relational databases, YDB [scales out](https://en.wikipedia.org/wiki/Scalability#Horizontal_or_scale_out), providing developers with the capability to simply extend clusters with computation or storage resources to handle increasing load. YDB has disaggregated storage and compute layers, which allow you to scale storage and compute resources independently. -Current production installations have more than 10,000 nodes, store petabytes of data and handle millions distributed transactions per second. +Current production installations have over 10000 nodes, store petabytes of data, and handle millions of distributed transactions per second. ### Automatic Disaster Recovery -YDB has built-in automatic recovery support to survive a hardware failure. After unpredictable disk, node, rack or even datacenter failure YDB remains fully available for reads and writes and restores required data redundancy automatically. +YDB's built-in automatic recovery support allows it to seamlessly survive hardware failures. After unpredictable disk, node, rack, or even datacenter failure, YDB remains fully available for reads and writes and automatically restores required data redundancy. ### Multitenant and Serverless Database -YDB has support for multitenant and serverless setups. A user can run a YDB cluster and create several databases that share one pool of storage and have different compute nodes. Alternatively a user can run several serverless databases that share one pool of compute resources to utilize them effectively. + +YDB supports multitenant and serverless setups. A user can run a YDB cluster and create several databases that share one pool of storage and have different compute nodes. Alternatively, a user can run several serverless databases that share one pool of compute resources to utilize them effectively. ## Supported Platforms ### Minimal system requirements -YDB runs on x86 64bit platforms with minimum 8 GB of RAM. +YDB runs on x86 64-bit platforms with at least 8 GB of RAM. ### Operating Systems -We have major experience running production systems on 64-bit x86 machines working under Ubuntu Linux. +In most production environments, YDB runs on 64-bit x86 machines working under Ubuntu Linux. -For development purposes we test that YDB could be built and run under latest versions of MacOS and Microsoft Windows on a regular basis. +For development purposes, it is regularly tested that YDB can be compiled and run under the latest versions of MacOS and Microsoft Windows. ## Getting Started -1. Install YDB using [pre-built executables](https://ydb.tech/en/docs/getting_started/self_hosted/ydb_local), [build it from source](BUILD.md) or [use Docker container](https://ydb.tech/en/docs/getting_started/self_hosted/ydb_docker). -1. Install [command line interface](https://ydb.tech/en/docs/getting_started/cli) tool to work with scheme and run queries. -1. Start [local cluster](https://ydb.tech/en/docs/getting_started/self_hosted/ydb_local) or container and run [YQL query](https://ydb.tech/en/docs/yql/reference/) via [YDB CLI](https://ydb.tech/en/docs/getting_started/cli). -1. Access [Embedded UI](https://ydb.tech/en/docs/maintenance/embedded_monitoring/) via browser for schema navigation, query execution and other database development related tasks. -1. Run available [example application](https://ydb.tech/en/docs/reference/ydb-sdk/example/go/). -1. Develop an application using [YDB SDK](https://ydb.tech/en/docs/reference/ydb-sdk/). +If you want to experiment with YDB, start with the [Quick Start guide](https://ydb.tech/docs/en/quickstart). It will yield a single-node cluster suitable for functional testing, app development, and similar tasks. -## How to Build from Source Code -* Build server (ydbd) and client (ydb) binaries [from source code](BUILD.md). +Suppose you want to jump into more serious scenarios like testing YDB fault tolerance, running performance benchmarks, or even running production or preproduction workloads. In that case, you'll need a full-fledged multi-node YDB cluster that can be deployed with either [Ansible](https://ydb.tech/docs/en/devops/ansible/initial-deployment) for bare metal or virtual machines or [Kubernetes](https://ydb.tech/docs/en/devops/kubernetes/initial-deployment) for containers. -## How to Deploy +## How to Build from Source Code -* Deploy a cluster [using Kubernetes](https://ydb.tech/en/docs/deploy/orchestrated/concepts). -* Deploy a cluster using [pre-built executables](https://ydb.tech/en/docs/getting_started/self_hosted/ydb_local). +Instructions on how to build YDB server (ydbd) and client (ydb) binaries are provided in [BUILD.md](BUILD.md). Also, see documentation on [Ya Make build system](https://ydb.tech/docs/en/contributor/build-ya). ## How to Contribute -We are glad to welcome new contributors! +We are glad to welcome new contributors! The [contributor's guide](CONTRIBUTING.md) provides more details on how to get started as a contributor. -1. Please read the [contributor's guide](CONTRIBUTING.md). -2. We can accept your work to YDB after you have signed contributor's license agreement (aka CLA). -3. Please don't forget to add a note to your pull request, that you agree to the terms of the CLA. +There's also a separate section of [YDB documentation for contributors](https://ydb.tech/docs/en/contributor/), mostly with more technical content. ## Success Stories -Take a look at YDB [web site](https://ydb.tech/) for the latest success stories and user scenarios. +Visit YDB [website](https://ydb.tech/) for the latest success stories and user scenarios.