Feature

README.md

@@ -1,35 +1,147 @@
-# pymongo-api
+# MongoDB Sharded Cluster with Docker Compose
+
+Этот проект разворачивает MongoDB шардинговую кластерную архитектуру, включая конфигурационный сервер, шарды с репликационными наборами, маршрутизатор (`mongos`) и Redis. Все компоненты запускаются с помощью `docker-compose`.
+
+---
+
+## Содержание
+- [Требования](#требования)
+- [Структура проекта](#структура-проекта)
+- [Как запустить](#как-запустить)
+- [Описание сервисов](#описание-сервисов)
+
+---
+
+## Требования
+Перед запуском убедитесь, что на вашем компьютере установлены:
+- [Docker](https://docs.docker.com/get-docker/)
+- [Docker Compose](https://docs.docker.com/compose/install/)
+
+---
+
+## Структура проекта
+- **`docker-compose.yml`**: Основной файл для описания сервисов.
+- **`scripts/mongo-init.sh`**: Скрипт для инициализации репликационных наборов и настройки шардинга.
+- **`redis/redis.conf`**: Конфигурационный файл для Redis.
+
+---
 
 ## Как запустить
 
-Запускаем mongodb и приложение
+1. **Клонировать репозиторий**
+   ```bash
+   git clone <url_вашего_репозитория>
+   cd <имя_папки>
 
-```shell
-docker compose up -d
-```
+2. **Запустить контейнеры**
+
+   ```bash
+   docker-compose up -d
+
+
+3.	**Подождать инициализации**
 
-Заполняем mongodb данными
+Вся инфраструктура автоматически поднимется и будет инициализирована, включая репликационные наборы и шардирование. Для проверки статуса выполнения можно просмотреть логи:
 
-```shell
-./scripts/mongo-init.sh
+```bash
+   docker-compose logs
 ```
+4. **Заполнить данными**
+
+    ```bash
+   docker exec -it mongos_router mongosh --port 27020
+    ```
+
+    ```bash
+   use somedb
+    ```
+
+     ```bash
+   for(var i = 0; i < 1000; i++) db.helloDoc.insert({age:i, name:"ly"+i})
+    ```
+
+5. **Проверить работоспособность**
+
+ •	MongoDB маршрутизатор доступен по адресу localhost:27020.
+ •	Redis доступен по порту 6379.
+
+## Описание сервисов
+
+Конфигурационный сервер (configSrv)
 
-## Как проверить
+	•	Назначение: Управляет метаданными шардинга.
+	•	Порт: 27017
+	•	Флаги запуска:
+	•	--configsvr: Запуск в режиме конфигурации.
+	•	--replSet config_server: Репликационный набор для надежности.
 
-### Если вы запускаете проект на локальной машине
+Шарды
 
-Откройте в браузере http://localhost:8080
+Shard 1 (shard1) и его реплики
 
-### Если вы запускаете проект на предоставленной виртуальной машине
+	•	Порты:
+	•	Основной: 27018
+	•	Реплики: 27021, 27022
+	•	Флаги запуска:
+	•	--shardsvr: Запуск в режиме шарда.
+	•	--replSet shard1: Репликационный набор.
 
-Узнать белый ip виртуальной машины
+Shard 2 (shard2) и его реплики
 
-```shell
-curl --silent http://ifconfig.me
+	•	Порты:
+	•	Основной: 27019
+	•	Реплики: 27023, 27024
+	•	Флаги запуска:
+	•	--shardsvr: Запуск в режиме шарда.
+	•	--replSet shard2: Репликационный набор.
+
+Маршрутизатор (mongos_router)
+
+	•	Назначение: Упрощает доступ к шардинговой архитектуре.
+	•	Порт: 27020
+	•	Флаги запуска:
+	•	--configdb config_server/configSrv:27017: Указывает на конфигурационный сервер.
+	•	--bind_ip_all: Доступ из любой сети.
+
+Redis
+
+	•	Назначение: Сервис для кеширования.
+	•	Порт: 6379
+	•	Конфигурация: Использует файл redis/redis.conf.
+
+Сервис инициализации (init)
+
+	•	Назначение: Выполняет инициализацию кластера:
+	•	Настраивает репликационные наборы.
+	•	Добавляет шарды в конфигурацию.
+	•	Скрипт запуска: scripts/mongo-init.sh
+
+Полезные команды
+
+Остановить контейнеры
+
+```bash
+docker-compose down
+```
+Посмотреть логи конкретного контейнера
+
+```bash
+docker logs <имя_контейнера>
 ```
+Перезапустить сервис
+
+```bash
+docker-compose restart <имя_сервиса>
+```
+
+Замечания
+
+1. Сетевые настройки:
+Все сервисы подключены к сети app-network с диапазоном IP-адресов 173.17.0.0/16.
+2.	Проверка MongoDB:
+Для выполнения команд можно подключаться через mongosh:
 
-Откройте в браузере http://<ip виртуальной машины>:8080
+mongosh --host localhost:27020
 
-## Доступные эндпоинты
+Используйте команду sh.status() для просмотра текущего состояния шардинга.
 
-Список доступных эндпоинтов, swagger http://<ip виртуальной машины>:8080/docs