Документация проекта не полная
sxiii opened this issue · comments
- CYBERWAY_HTTP_URL=https://node-cyberway
Окей, где инструкции как запустить CYBERWAY_HTTP? Ведь это треубется для запуска этого проекта. Наверное, вот это? (Но это только мои домыслы!)
- BLOCKCHAIN_BROADCASTER_URL=nats://user:password@nats-cyberway:4222
Окей, где инструкции как запустить NATS-сервер? Ведь это треубется для запуска этого проекта. Наверное, вот это? (Но это только мои домыслы)
Как и вообще понимать, из чего состоит система полностью и какие сервисы нужно запускать и в каком порядке. Какие сервисы должны быть на отдельных серверах - обязательно? Какие могут сидеть на одном, но с возможными ограничениями? Какие можно совершенно спокойно запускать на одном и том же сервере?
Ясно, что всё в докере, но, к примеру, если необходимо 10 работающих контейнеров, 6 из которых "лёгкие" и могут соседствовать, 2 - "средние" и теоритически могут а ещё 2 - "тяжёлые" и их например лучше выносить на отдельные сервера. Тут же было бы полезно видеть минимальные требования к соответствующим перечисленным серверам.
Из документации должно быть ясно, как собрать с полного нуля всю инфраструктуру и заставить её корректно работать.
Подробно, со схемами работы сервисов, с объяснением, как запустить отдельные части проекта на отдельных серверах, какие сревера для каких частей использовать и так далее.
Иначе - это репозиторий невозможно использовать в реальной жизни.
Для запуска ноды CyberWay нужно использовать репозиторий:
https://github.com/cyberway/cyberway.launch
Репозиторий содержит два шелл-скрипта:
- start_light.sh - для запуска облегченной ноды
- start_full_node.sh - для запуска полной ноды с поддержкой nats-streaming сервера, который нужен для запуска сервисов golos.io
Из чего состоит система можно посмотреть в docker-compose.yml.
"Тяжёлые" контейнеры - prism-node и wallet-node
Спасибо за обновление документации, стало уже намного лучше! Так что я закрою этот тикет.
Документация по прежнему не позволяет запустить рабочий сервис Golosio
Нужно (как я это вижу):
- увеличить подробность документации в несколько раз
- добавить ссылки на информацию о всех частях системы
- добавить описание какие сервисы где должны работать и рекомендуемое железо
- добавить ссылки на документацию о NATS и как это настраивать
- проделать полный путь от первого шага до последнего с нуля чтобы системы и сервисы заработали
- учесть какие ошибки могут совершать те кто следуют документации и предостеречь их от этих ошибок
- там где требуются специальные действия добавить все эти действия подробно в документацию
- добавить всё что может быть важным и о чём я мог забыть тут упомянуть
У меня не получилось после недели попыток, страданий, issue и диалогов в чате.
Сомневаюсь что ещё у кого-то получится если не улучшить документацию драматически, добавив всё что есть выше из списка "Нужно"