doc: document how to use tesseract serve --network parameter

[zmheiko]

This addresses the lack of documentation around network usage and some of its pitfalls.

Relevant issue or PR

This acts as a stopgap for #410. Moving forward, more tooling around network usage is needed.

Description of changes

Add documentation

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 66.77%. Comparing base (e41824f) to head (9a77e55).
⚠️ Report is 1 commits behind head on main.

❗ There is a different number of reports uploaded between BASE (e41824f) and HEAD (9a77e55). Click for more details.

HEAD has 27 uploads less than BASE

Flag	BASE (e41824f)	HEAD (9a77e55)
	34	7

Additional details and impacted files

@@             Coverage Diff             @@
##             main     #530       +/-   ##
===========================================
- Coverage   76.95%   66.77%   -10.19%     
===========================================
  Files          32       32               
  Lines        4409     4409               
  Branches      730      730               
===========================================
- Hits         3393     2944      -449     
- Misses        716     1226      +510     
+ Partials      300      239       -61     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[dionhaefner]

Thanks @zmheiko ! Do you think we should pull the trigger and also create networks passed with --network if they don't exist, or is there another footgun to that I'm not seeing?

[zmheiko]

Thanks @zmheiko ! Do you think we should pull the trigger and also create networks passed with --network if they don't exist, or is there another footgun to that I'm not seeing?

The only drawback that I'm seeing is that the user might pass a wrong network name (e.g. XXY), misses the emitted "new network XXY created" message (that I assume we'd add), and then wonders why the new Tesseract cannot communicate with the existing ones in network XXX. So maybe an additional --create-network flag that needs to be passed on top of the --network=XXX args would be useful to make sure networks are created intentionally instead of by accident because of a typo. Does that make sense?

[zmheiko]

I updated the documentation and added a Ping-Tesseract that can be used to check if networking works. I tested it on Mac (with Colima, but this should behave the same way as Docker Desktop) and a Azure Linux VM (with Docker Engine). As expected, with --network=host pinging pasteurlabs.ai works but localhost fails on Mac. On Linux both succeed.

[zmheiko]

#544 tackles automatic network creation. Let's revisit the doc changes after, as you suggested @dionhaefner.

[dionhaefner]

Done, @zmheiko do your thang