New Options to cartesi.toml

[lynoferraz]

While working on cartesapp framework I added some extra features that improved the experience and I think could easily be added in the cli too. All the features described here are controlled via the cartesi.toml file.

[machine] block

• workdir = "path": Sets the workdir on the cartesi-machine cli wiht --workdir=path. Overrides docker WORKDIR command.
• entrypoint = "command": Sets the entrypoint on the cartesi-machine cli wiht -- command. Overrides docker ENTRYPOINT and CMD commands.
• envs = ["env1=val1",...]: Additional envs to be set in the env
• network = "true": enable network to customize the rootfs in shell mode.
• no_bootargs = "true|false": enable option.
• no_rollup = "true|false": enable option.
• init = ["cmd1","cmd2",...]: Additional --append-init options.
• bootargs = ["cmd1","cmd2",...]: Additional --append-bootargs options.

[drive] block

for format = "ext2"

• size = "size str": use xgenext2fs --size-in-blocks=blocks option (it should convert first)

for builder = "docker".

• format = "none": Allows an unchanged format. This allows to create files in a dockerfile step and used it unchanged as a flash drive. Useful for creating state files or drives directly in a docker step.
• output_type = "none|tar": Set the output type in --output option. "None" type allows to create files in steps of the docker. Default: "tar" (normally it should be converted to sqfs or ext2 to be used by the CM). Note that the none output type normally creates a dir at he the dest= location, so the flash drive itself should be the file inside the location.

for builder = "raw".

• builder = "raw": create a raw empty drive that simply has length property. E.g. --flash-drive=label:state,mount:false,user:dapp,length:67108864. Useful for state flash drives (like honeypot)
• length = "size str": option used with builder=raw that should be converted to bytes

for builder = "volume".

• builder = "volume": mount a local directory (requires directory = "path") option as volume to customize the rootfs in shell mode.

cli

It would be good to allow any cartesi.toml configuration to be customized/overiden when using the cartesi build/cartesi shell commands (e.g. cartesi shell --machine-config "network=true" --machine-config "workdir=/mnt/app" --drive-config "app.mount=/mnt/app").

[brunomenezes]

@lynoferraz Are these extra configurations necessary for you often, or only in specific cases? Is this cartesapp doing this "workaround" for you to cover what is not available? How does it work at the moment for you?

I will also mark @tuler, @endersonmaia, and @vfusco for comment.

[lynoferraz]

Regarding the drive options, I would say the only one that I don't always use is the builder = "raw", because I'm using the output_type to prepare the state file in a docker step, at least for the recent projects which use a state flash drive.
Indeed, we could already use a state file built on the host and use the builder = "none", but I think it would be simplified using these options.
Regarding the machine options, I frequently use workdir, entrypoint, envs. The others I don't use that often, but I needed them at least once.
The builder = "volume" and networkoptions are interesting only to customize the rootfs, so it is limited since you should be doing that in a Dockerfile.., but it is good for testing. This particularly works well with the extra --drive-config and --machine-config cli flags.