Open Anyitechs opened 1 month ago
Really good thank you! Besides the -dev thing mentioned below, I think we should also
- Mention the just command that macro's each of these. So at the top you can mention the
just
option, and then for each section just add the corresponding (example)just startd
- I think we should also include port forwarding which is required to send RPC commands from local user into the cluster. That is started with
just p
from the justfile and the fill command is likekubectl portforward 9276....
something something something.Thank you!
Thank you for the review. I'll work on these and update the PR.
When we run the network using minikube, is it still a "Docker network"? I noticed that the documentation talks about minikube and docker as two options to run the system, however, when I eventually run warcli network start
, it gives me a result that talks about which Docker network I am using:
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Temp dir ┃ Bitcoin network ┃ Docker network ┃ Subnet ┃ Graph ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ /home/grant/.warnet/warnet/… │ regtest │ warnet │ 100.0.0.0/8 │ MultiDiGraph with 12 nodes and 11 │
│ │ │ │ │ edges │
└───────────────────────────────────────┴─────────────────┴────────────────┴─────────────┴───────────────────────────────────────┘
As a new user, I want to run most of these commands using the
justfile
. Is it possible to direct users to thejustfile
features and then give them the option to explore the nitty gritty details?One idea is to provide the justfile command up front and then give users the option to explore that command in more detail using collapsing sections
Running Warnet
just start
- starts a minikube clusterstart details
just startd
- starts a minikube cluster in debug modestartd details
Thank you for this. I've effected the changes using collapsing sections.
is it still a "Docker network"
good catch @mplsgrant the title of that column should probably be "network name"
I've addressed all the feedbacks here @pinheadmz.
Let me know if there's anything I'm missing.
Thank you @mplsgrant for the detailed review and feedbacks. I've addressed all the feedbacks and moved the logging details into a seperate file in the documentation (logging.md).
Let me know if I missed anything.
cc: @pinheadmz
At a high level, one thing I would like to do after completing the steps in Running Warnet is I want to be able to run this: warcli scenarios run tx_flood
. Not because tx_flood is special, but rather it let's the user know they are now set up with a warnet installation.
This way, new users can feel great about getting warnet installed using the steps from the Installation page, and then they can feel even better seeing warnet running after completing the steps in Running Warnet. I really want users to be able to step through those two pages and have something really cool to look at and play with.
This PR documents the Kubernetes deployment workflow/commands in
/justfile
intorunning.md
. It follows the first option here to document the commands explicitly, and closes issue #308