This repository has been archived by the owner on Dec 23, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feature/docs: improve documentation (#27)
* feature/docs: fix static path & add 1 more line about vhsard library base & add logo image alt * feature/docs: add quickstart guide --------- Co-authored-by: Maksim Konovalov <maksim.konovalov@vk.team>
- Loading branch information
1 parent
cb8c86a
commit 33d6172
Showing
7 changed files
with
51 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Go-Vshsard Quick Start |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Go-Vshsard Полная документация | ||
|
||
|
||
## Содержание | ||
|
||
- [Цели и задачи библиотеки](#цели-и-задачи-библиотеки) | ||
- [Теория](#теория) | ||
- [Tarantool](#tarantool) | ||
- [Шардирование](#шардирование) | ||
- [Начало тестирования](#начало-тестирования) | ||
|
||
# Цели и задачи библиотеки | ||
Стандартная конфигурация кластера с шардированием происходит следующим образом: | ||
1. Устанавливается кластер шардов. Представим что это 2 репликасета(мастер реплика). | ||
2. Устанавливается прокси роутер на tarantool, на котором так же необходимо дописывать логику для походов в storage, | ||
который занимается тем что следит где какой бакет находится и ходить напрямую. | ||
|
||
Тем самым мы избавляемся от дополнительной точки отказа, а так же уменьшаем число сетевых походов. | ||
Так же это позволяет адаптировать работу с шардами к комьюнити Golang. | ||
Увеличить поддержку, удобство отладки и производительность. | ||
|
||
**Цель и задача библиотеки** заключаются в том, чтобы дать пользователям | ||
возможность ходить в репликасеты не используя Tarantool Router инсталяцию, | ||
а резолвить бакеты и понимать в какой сторадж ходить прямо из вашего сервиса. | ||
# Теория | ||
## Tarantool | ||
Tarantool — платформа in-memory вычислений с гибкой схемой данных для эффективного создания высоконагруженных приложений. | ||
Включает в себя базу данных и сервер приложений на Lua. | ||
Подробнее ознакомиться можно на официальном сайте Tarantool. | ||
## Шардирование | ||
Подробнее про технологию виртуального шардирования а так же про библиотеку vhsard вы можете найти в | ||
https://www.youtube.com/watch?v=_9zUB0vmRxM | ||
А так же внутри [оригинальной библиотеки vshard](https://github.com/tarantool/vshard). | ||
## Начало тестирования | ||
1. Для установки кластера вам потребуются следующие зависимости | ||
- [Tarantool 2.x](https://www.tarantool.io/en/download/os-installation/os-x/), для ОС Mac OS необходимо устанавливать с помощью [tt](https://github.com/tarantool/tt) install | ||
2. Сконфигурировать кластер и библиотеку, примеры можно подробнее посмотреть в examples |
File renamed without changes
File renamed without changes
File renamed without changes