add quick_start

[mplsgrant]

Issue

New users have a hard time getting going with Warnet.

Cause

Warnet has lots of dependencies that stand in the way of starting up warnet.

Solution

Create a quickstart script that checks for dependencies and points the user in the right direction for meeting those dependencies. The quickstart should also fire up a basic 12 node default warnet.

• minikube
• kubectl
• docker
• docker permissions
• just
• python3
• venv
• BPF

[willcl-ark]

A few shellcheck suggestions:

will@ubuntu in ~/src/warnet on  2024-05-ez-startup [$?] : 🐍 (warnet)
₿ shellcheck quick_start.sh

In quick_start.sh line 42:
current_git=$(basename `git rev-parse --show-toplevel` || true)
                       ^-----------------------------^ SC2046 (warning): Quote this to prevent word splitting.
                       ^-----------------------------^ SC2006 (style): Use $(...) notation instead of legacy backticks `...`.

Did you mean:
current_git=$(basename $(git rev-parse --show-toplevel) || true)


In quick_start.sh line 113:
bpf_status=$(grep CONFIG_BPF /boot/config-$(uname -r) || true)
                                          ^---------^ SC2046 (warning): Quote this to prevent word splitting.


In quick_start.sh line 132:
source .venv/bin/activate
       ^----------------^ SC1091 (info): Not following: .venv/bin/activate was not specified as input (see shellcheck -x).

For more information:
  https://www.shellcheck.net/wiki/SC2046 -- Quote this to prevent word splitt...
  https://www.shellcheck.net/wiki/SC1091 -- Not following: .venv/bin/activate...
  https://www.shellcheck.net/wiki/SC2006 -- Use $(...) notation instead of le...

[willcl-ark]

This is lush, love it:

[mplsgrant]

Looks like the build test is failing. https://github.com/bitcoin-dev-project/warnet/actions/runs/9306448844/job/25616111319#step:4:2456

Will look into this.

Update: appears to be some kind of issue on a 'remote providers' end:

build-test
Received request to deprovision: The request was cancelled by the remote provider.

Update 2: It passes on re-run. Maybe some kind of hang-up with a remote server (docker hub's?). I created an issue (#374) to keep an eye on it.

[mplsgrant]

A few shellcheck suggestions:

@willcl-ark Solved. Thank you.

[willcl-ark]

Looks great to me, nice work! Tested on Linux where everything was already installed, and macos where it failed midway. Didn't test each step, but code looks good to me.

Left a few comments with optional changes -- feel free to ignore them (all), or make changes you agree with. Let me know when you're done and I will hit that merge button!

[mplsgrant]

One thing I noticed is that warcli network connected gobbles up the output somehow. So, I can't do this..

while `warcli` network connected | grep -q "False"; do
    echo "Something reassuring for the user"
    sleep 2
done

[mplsgrant]

Let me know when you're done and I will hit that merge button!

@willcl-ark I updated with your recommendations.

What was up with macos failing midway?

[willcl-ark]

Let me know when you're done and I will hit that merge button!

@willcl-ark I updated with your recommendations.

Sweet, LGTM!

What was up with macos failing midway?

Oh, only that I don't have minikube on it, so got to see it "fail successfully"