Laundry list: `nwaku` operator guide improvements

waku-org / nwaku

Waku node and protocol.

Other

200 stars 53 forks source link

Laundry list: `nwaku` operator guide improvements #1003

Open jm-clius opened 2 years ago

jm-clius commented 2 years ago

This is a laundry list of possible improvements, tutorials or clarifications we could add to the nwaku operator guide.

[x] How to set up a Droplet (or any cloud computing service) to run a nwaku node
[ ] How to configure dynamic DNS for your node
[ ] How to set up your own DNS discovery domain, including creating an ENR tree, linking to other trees, etc.
[x] Docker compose file added cc @alrevuelta: https://github.com/waku-org/nwaku/pull/1444

jm-clius commented 2 years ago

This issue may not be very relevant anymore, as the open tasks are not much requested tutorials in the operator guide. Still, could be useful, so keeping this on the release radar.

alrevuelta commented 1 year ago

Related to the docker-compose item. Not sure if it should be part of the repo or community maintained, but this is what I meant. https://github.com/alrevuelta/nwaku-compose.

A simple docker-compose that with just docker-compose up -d you get nwaku, grafana and prometheus up un running in literally 5 seconds. Everything is already provisioned for you, dashboards, integration between all components, etc.

It's also cloud-friendly, and can be deployed with minimum effort in bare metal or cloud proviers like digital ocean, in just two steps.

jm-clius commented 1 year ago

@alrevuelta this is super useful. Thanks! As a start, to get visibility, could we link to this repo and instructions from the existing operator documents (perhaps the different Docker How-To guides), such as the docker quickstart. I think this can even be a cursive subtitle to the page. Once the new guide page is setup, we can try to integrate this even more into the operator docs.

alrevuelta commented 1 year ago

Sure! https://github.com/waku-org/nwaku/pull/1444