v1.1 Feature Map

This page is the coverage checklist for the v1.1 docs rewrite.

If a feature exists in Yeast v1.1, it should have a clear docs home here.

CLI Commands

Command	Primary Docs Home
`yeast doctor`	Installation, Troubleshooting
`yeast init`	Quickstart, Templates, Commands
`yeast pull`	Images Concept, Images Reference, Commands
`yeast images clean`	Manage Image Cache, Commands
`yeast up`	Lifecycle, Commands, Yeast Labs
`yeast down`	Lifecycle, Commands, Yeast Labs
`yeast destroy`	Lifecycle, Commands, Yeast Labs
`yeast status`	Guest Control, Lab 4, Commands
`yeast inspect`	Guest Control, Lab 4, Commands
`yeast logs`	Guest Control, Troubleshooting, Commands
`yeast ssh`	First VM, Guest Control, Commands
`yeast exec`	Guest Control, Lab 4, Commands
`yeast copy`	Guest Control, Lab 4, Commands
`yeast provision`	Provisioning, Rerun Provisioning, Commands
`yeast snapshot`	Snapshots, Lab 5, Commands
`yeast snapshots`	Snapshots, Commands
`yeast restore`	Snapshots, Lab 5, Commands
`yeast delete-snapshot`	Snapshots, Commands
`yeast update`	Update Yeast, Commands
`yeast docs`	Quickstart, Commands
`yeast completion`	Commands
`yeast version`	Installation, Commands

Field	Primary Docs Home
`version`	yeast.yaml Reference
`management_host`	Networking, yeast.yaml Reference
`networks`	Networking, yeast.yaml Reference
`networks[].name`	yeast.yaml Reference
`networks[].cidr`	Networking, yeast.yaml Reference
`provision`	Provisioning, yeast.yaml Reference
`provision.packages`	Provisioning, yeast.yaml Reference
`provision.files`	Provisioning, yeast.yaml Reference
`provision.files[].source`	yeast.yaml Reference
`provision.files[].destination`	yeast.yaml Reference
`provision.files[].permissions`	yeast.yaml Reference
`provision.shell`	Provisioning, yeast.yaml Reference
`instances`	Projects, yeast.yaml Reference
`instances[].name`	yeast.yaml Reference
`instances[].hostname`	Cloud-Init, yeast.yaml Reference
`instances[].image`	Images Concept, Images Reference, yeast.yaml Reference
`instances[].memory`	yeast.yaml Reference
`instances[].cpus`	yeast.yaml Reference
`instances[].disk_size`	yeast.yaml Reference
`instances[].ssh_port`	Networking, yeast.yaml Reference
`instances[].user`	Cloud-Init, yeast.yaml Reference
`instances[].sudo`	Cloud-Init, yeast.yaml Reference
`instances[].env`	Provisioning, yeast.yaml Reference
`instances[].user_data`	Cloud-Init, yeast.yaml Reference
`instances[].networks`	Networking, yeast.yaml Reference
`instances[].networks[].name`	yeast.yaml Reference
`instances[].networks[].ipv4`	Networking, yeast.yaml Reference
`instances[].provision`	Provisioning, yeast.yaml Reference

The current image list lives in Images.

Use this command to confirm the list from the installed CLI:

yeast pull --list

Do not teach these as public config fields yet: