Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Документация проекта не полная #2

Open
sxiii opened this issue Sep 13, 2020 · 4 comments
Open

Документация проекта не полная #2

sxiii opened this issue Sep 13, 2020 · 4 comments

Comments

@sxiii
Copy link

sxiii commented Sep 13, 2020

  1. CYBERWAY_HTTP_URL=https://node-cyberway

Окей, где инструкции как запустить CYBERWAY_HTTP? Ведь это треубется для запуска этого проекта. Наверное, вот это? (Но это только мои домыслы!)

  1. BLOCKCHAIN_BROADCASTER_URL=nats://user:password@nats-cyberway:4222

Окей, где инструкции как запустить NATS-сервер? Ведь это треубется для запуска этого проекта. Наверное, вот это? (Но это только мои домыслы)

Как и вообще понимать, из чего состоит система полностью и какие сервисы нужно запускать и в каком порядке. Какие сервисы должны быть на отдельных серверах - обязательно? Какие могут сидеть на одном, но с возможными ограничениями? Какие можно совершенно спокойно запускать на одном и том же сервере?

Ясно, что всё в докере, но, к примеру, если необходимо 10 работающих контейнеров, 6 из которых "лёгкие" и могут соседствовать, 2 - "средние" и теоритически могут а ещё 2 - "тяжёлые" и их например лучше выносить на отдельные сервера. Тут же было бы полезно видеть минимальные требования к соответствующим перечисленным серверам.

Из документации должно быть ясно, как собрать с полного нуля всю инфраструктуру и заставить её корректно работать.

Подробно, со схемами работы сервисов, с объяснением, как запустить отдельные части проекта на отдельных серверах, какие сревера для каких частей использовать и так далее.

Иначе - это репозиторий невозможно использовать в реальной жизни.

@afalaleev
Copy link
Member

Для запуска ноды CyberWay нужно использовать репозиторий:
https://github.com/cyberway/cyberway.launch

Репозиторий содержит два шелл-скрипта:

  1. start_light.sh - для запуска облегченной ноды
  2. start_full_node.sh - для запуска полной ноды с поддержкой nats-streaming сервера, который нужен для запуска сервисов golos.io

@b1acksun
Copy link
Contributor

b1acksun commented Oct 6, 2020

Из чего состоит система можно посмотреть в docker-compose.yml.
"Тяжёлые" контейнеры - prism-node и wallet-node

@sxiii
Copy link
Author

sxiii commented Oct 20, 2020

Спасибо за обновление документации, стало уже намного лучше! Так что я закрою этот тикет.

@sxiii sxiii closed this as completed Oct 20, 2020
@sxiii sxiii reopened this Oct 25, 2020
@sxiii
Copy link
Author

sxiii commented Oct 25, 2020

Документация по прежнему не позволяет запустить рабочий сервис Golosio

Нужно (как я это вижу):

  • увеличить подробность документации в несколько раз
  • добавить ссылки на информацию о всех частях системы
  • добавить описание какие сервисы где должны работать и рекомендуемое железо
  • добавить ссылки на документацию о NATS и как это настраивать
  • проделать полный путь от первого шага до последнего с нуля чтобы системы и сервисы заработали
  • учесть какие ошибки могут совершать те кто следуют документации и предостеречь их от этих ошибок
  • там где требуются специальные действия добавить все эти действия подробно в документацию
  • добавить всё что может быть важным и о чём я мог забыть тут упомянуть

У меня не получилось после недели попыток, страданий, issue и диалогов в чате.

Сомневаюсь что ещё у кого-то получится если не улучшить документацию драматически, добавив всё что есть выше из списка "Нужно"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants