Final changes for mainnet roundtrip + significant documentation update #109
Conversation
make keep unsealed configurable from the command line, with default to true
Improve the motion readme to contain a reasonable set of instructions for deploying it in production. Also heavily comment the .env file
hannahhoward
force-pushed
the
feat/document-and-complete-mainnet-roundtrip
branch
from
01fd399 to
1a7079d
Compare
|
|
||
| ```shell | ||
| docker run --rm -p 40080:40080 -v $PWD/store:/store ghcr.io/filecoin-project/motion:main --storeDir=/store | ||
| curl http://localhost:40080/v0/blob/ad7ef987-a932-495c-aa0c-7ffcabeda45f/status | jq . |
There was a problem hiding this comment.
this example will lead to support questions around it not working. need to be clear to users how to get a blob ID from the previous call.
There was a problem hiding this comment.
it's pretty similar to retrieve example above no?
cmd/motion/main.go
Outdated
| &cli.BoolFlag{ | ||
| Name: "keepUnsealed", | ||
| Usage: "whether storage providers should retain an unsealed copy for motion deals to make them retrievable", | ||
| DefaultText: "storage providers WILL maintain an unsealed copy", | ||
| Value: true, | ||
| EnvVars: []string{"MOTION_KEEP_UNSEALED"}, |
There was a problem hiding this comment.
i don't think this is something we expose on the CLI like this?
eventually, we get a boost API and have usage support when we ask for unsealing sealed-only content. I don't think we want a global option for the ISV to signal not to do that part? or at least it's not on the requirement control docs i've seen.
if they want it, they should do it by specifying it through their contract with their pool of SPs, not here.
There was a problem hiding this comment.
yea that's potentially reasonable. part of the reason I exposed it was before we were defaulting to false, which was wrong. No we're defaulting to true -- but I can remove the ability to ever set it false.
There was a problem hiding this comment.
yeah, lets remove that ability for now.
hannahhoward
deleted the
feat/document-and-complete-mainnet-roundtrip
branch
Goals
This is a few last changes identified while I was completing a mainnet deal with motion, and then I added significant documentation to the .env.example file plus greatly expanded the readme to cover all aspects of actually setting up motion for prod.
Implementation
For discussion
This removes the motion command output, and makes the README much more client oriented rather than dev oriented. Maybe this is just good raw materials from which to write formal Motion docs and doesn't belong in a README. Anyway, I just wanted to get it down.