Proper Service/Storage Provider Documentation

[philwinder]

As a storage provider, I want simple, coherent instructions explaining how to setup bacalhau and connect it to the mainnet.

Context: We currently have this page https://docs.bacalhau.org/running-node/overview, but it basically just explains the serve command.

Known needs:

• [ ] What hardware requirements are there?
• [ ] What OSs are supported?
• [ ] OS/Library prerequisite instructions (e.g. Docker)
• [ ] Connecting to the mainnet

Unknowns (you need to ask people about these and refine accordingly):

• Prometheus/Grafana?
• Honeycomb/tracing?
• Lotus integration (see #561)

[lukemarsden]

Kai: documenting whole process was only partially done. What's missed?

1. Stand up a node by following the docs at https://docs.bacalhau.org/running-node/install, find the cracks in the pavement and fix them as we go.
2. Maybe add some more context.
3. Add a systemd unit. In particular, say if you want to use systemd then here's an example?
   • https://github.com/filecoin-project/bacalhau/blob/main/ops/terraform/remote_files/configs/bacalhau-daemon.service
   • https://github.com/filecoin-project/bacalhau/blob/main/ops/terraform/remote_files/configs/ipfs-daemon.service
   • https://github.com/filecoin-project/bacalhau/tree/main/ops/terraform/remote_files/scripts etc

[enricorotundo]

• Prometheus?
• Honeycomb?

[lukemarsden]

both are probably optional, although worth mentioning in the docs that they can be done!

[wesfloyd]

@enricorotundo my thoughts per the slack discussion are:

• [ ] Identify our preferred onboarding path for Compute Providers (CPs) during this testing phase - i.e. which specific narrowly defined steps do we wish for them to take. Luke or Kai might be the best person to define this?
• [ ] Confirm Luke and Kai whether our CP docs section should be built as a "linear, narrowly defined beta tester onboarding process for CPs", "a catch-all for related compute node operator topics that deserve to be documented somewhere" or some combination of the two.
• [ ] Add a section that specifies our minimum hardware, software and OS (operating system) requirements
• [ ] Update our docs accordingly

Is that helpful?

[wesfloyd]

10/5 zoom chat outcomes:

• Rename the landing page to be super simple for "Compute Providers (CPs)" with a narrow ordered list of instructions
• Remaining pages can be left as is as appendix / catch all content
• Maybe devstack testing is better for developers
• Will post completed docs to #bacalhau-compute-providers when ready and ask them to send feedback to #bacalhau slack or open an issue here
• Sharing previous SP/CP discussions here
• Last steps after "bacalhau serve" - do we have a way for them to validate serving simple test jobs? Store data locally with IPFS then submit a job against that CID?

Terms discussed:

• Compute Provider (CP) - anyone who is running a Bacalhau compute node participating in the Bacalhau compute network, regardless of whether they are hosting Filecoin data.
• Service Provider (SP) - entity running a Filecoin node storing filecoin data.

[enricorotundo]

new WIP version https://docs.bacalhau.org/running-node/

[enricorotundo]

New page: https://docs.bacalhau.org/running-node/quick-start

https://github.com/filecoin-project/bacalhau/issues/900 is the follow-up of this issue.