diff --git a/docs/.gitignore b/docs/.gitignore index 4ef9e7600..3006b271d 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,2 +1 @@ book/ -man/ diff --git a/docs/src/man/bcvk-ephemeral-ps.md b/docs/src/man/bcvk-ephemeral-ps.md new file mode 100644 index 000000000..209862d2b --- /dev/null +++ b/docs/src/man/bcvk-ephemeral-ps.md @@ -0,0 +1,38 @@ +# NAME + +bcvk-ephemeral-ps - List ephemeral VM containers + +# SYNOPSIS + +**bcvk ephemeral ps** [*OPTIONS*] + +# DESCRIPTION + +List ephemeral VM containers + +# OPTIONS + + +**--json** + + Output as structured JSON instead of table format + + + +# EXAMPLES + +List all running ephemeral VMs: + + bcvk ephemeral ps + +List ephemeral VMs with JSON output: + + bcvk ephemeral ps --json + +# SEE ALSO + +**bcvk**(8) + +# VERSION + + diff --git a/docs/src/man/bcvk-ephemeral-rm-all.md b/docs/src/man/bcvk-ephemeral-rm-all.md new file mode 100644 index 000000000..ee8689929 --- /dev/null +++ b/docs/src/man/bcvk-ephemeral-rm-all.md @@ -0,0 +1,47 @@ +# NAME + +bcvk-ephemeral-rm-all - Remove all ephemeral VM containers + +# SYNOPSIS + +**bcvk ephemeral rm-all** [*OPTIONS*] + +# DESCRIPTION + +Remove all ephemeral VM containers + +# OPTIONS + + +**-f**, **--force** + + Force removal without confirmation + + + +# EXAMPLES + +Remove all ephemeral VMs (will prompt for confirmation): + + bcvk ephemeral rm-all + +Remove all ephemeral VMs without confirmation: + + bcvk ephemeral rm-all --force + +Clean up after testing workflow: + + # Run some ephemeral test VMs + bcvk ephemeral run -d --rm --name test1 quay.io/fedora/fedora-bootc:42 + bcvk ephemeral run -d --rm --name test2 quay.io/fedora/fedora-bootc:42 + + # Clean up all at once + bcvk ephemeral rm-all -f + +# SEE ALSO + +**bcvk**(8) + +# VERSION + + diff --git a/docs/src/man/bcvk-libvirt-base-disks.md b/docs/src/man/bcvk-libvirt-base-disks.md new file mode 100644 index 000000000..d044a1296 --- /dev/null +++ b/docs/src/man/bcvk-libvirt-base-disks.md @@ -0,0 +1,22 @@ +# NAME + +bcvk-libvirt-base-disks - Manage base disk images used for VM cloning + +# SYNOPSIS + +**bcvk libvirt base-disks** [*OPTIONS*] + +# DESCRIPTION + +Manage base disk images used for VM cloning + + + + +# SEE ALSO + +**bcvk**(8) + +# VERSION + + diff --git a/docs/src/man/bcvk-libvirt-list-volumes.md b/docs/src/man/bcvk-libvirt-list-volumes.md new file mode 100644 index 000000000..4cdcee391 --- /dev/null +++ b/docs/src/man/bcvk-libvirt-list-volumes.md @@ -0,0 +1,68 @@ +# NAME + +bcvk-libvirt-list-volumes - List available bootc volumes with metadata + +# SYNOPSIS + +**bcvk libvirt list-volumes** [*OPTIONS*] + +# DESCRIPTION + +List available bootc volumes with metadata + +# OPTIONS + + +**--pool**=*POOL* + + Libvirt storage pool name to search + + Default: default + +**--json** + + Output as structured JSON instead of table format + +**--detailed** + + Show detailed volume information + +**--source-image**=*SOURCE_IMAGE* + + Filter by source container image + +**--all** + + Show all volumes (not just bootc volumes) + + + +# EXAMPLES + +List all bootc volumes in the default pool: + + bcvk libvirt list-volumes + +Show detailed volume information: + + bcvk libvirt list-volumes --detailed + +Filter volumes by source container image: + + bcvk libvirt list-volumes --source-image quay.io/fedora/fedora-bootc:42 + +List all volumes including non-bootc volumes: + + bcvk libvirt list-volumes --all + +Output as JSON for scripting: + + bcvk libvirt list-volumes --json + +# SEE ALSO + +**bcvk**(8) + +# VERSION + + diff --git a/docs/src/man/bcvk-libvirt-rm-all.md b/docs/src/man/bcvk-libvirt-rm-all.md new file mode 100644 index 000000000..20527ad26 --- /dev/null +++ b/docs/src/man/bcvk-libvirt-rm-all.md @@ -0,0 +1,63 @@ +# NAME + +bcvk-libvirt-rm-all - Remove multiple libvirt domains and their resources + +# SYNOPSIS + +**bcvk libvirt rm-all** [*OPTIONS*] + +# DESCRIPTION + +Remove multiple libvirt domains and their resources + +# OPTIONS + + +**-f**, **--force** + + Force removal without confirmation + +**--stop** + + Remove domains even if they're running + +**--label**=*LABEL* + + Filter domains by label (only remove domains with this label) + + + +# EXAMPLES + +Remove all stopped libvirt VMs (will prompt for confirmation): + + bcvk libvirt rm-all + +Remove all VMs without confirmation: + + bcvk libvirt rm-all --force + +Remove all VMs including running ones: + + bcvk libvirt rm-all --stop --force + +Remove all VMs with a specific label: + + bcvk libvirt rm-all --label environment=test --force + +Clean up test environment workflow: + + # Create some test VMs + bcvk libvirt run --name test1 --label purpose=testing quay.io/fedora/fedora-bootc:42 + bcvk libvirt run --name test2 --label purpose=testing quay.io/fedora/fedora-bootc:42 + + # Clean up only the test VMs + bcvk libvirt rm-all --label purpose=testing -f + +# SEE ALSO + +**bcvk**(8) + +# VERSION + + diff --git a/docs/src/man/bcvk-libvirt-status.md b/docs/src/man/bcvk-libvirt-status.md new file mode 100644 index 000000000..535ba78a1 --- /dev/null +++ b/docs/src/man/bcvk-libvirt-status.md @@ -0,0 +1,44 @@ +# NAME + +bcvk-libvirt-status - Show libvirt environment status and capabilities + +# SYNOPSIS + +**bcvk libvirt status** [*OPTIONS*] + +# DESCRIPTION + +Show libvirt environment status and capabilities + +# OPTIONS + + +**--format**=*FORMAT* + + Output format (yaml or json) + + Possible values: + - yaml + - json + + Default: yaml + + + +# EXAMPLES + +Show libvirt environment status (default YAML format): + + bcvk libvirt status + +Show status in JSON format: + + bcvk libvirt status --format json + +# SEE ALSO + +**bcvk**(8) + +# VERSION + +