mirror of
https://github.com/linka-cloud/d2vm.git
synced 2024-11-25 09:06:24 +00:00
docs: add container disk support
Signed-off-by: Adphi <philippe.adrien.nousse@gmail.com>
This commit is contained in:
parent
d652bf41f5
commit
bf2687a211
2
Makefile
2
Makefile
@ -68,7 +68,7 @@ tests:
|
|||||||
|
|
||||||
docs-up-to-date:
|
docs-up-to-date:
|
||||||
@$(MAKE) cli-docs
|
@$(MAKE) cli-docs
|
||||||
@git diff --quiet -- docs ':(exclude)docs/content/reference/d2vm_run_qemu.md' || (git --no-pager diff -- docs ':(exclude)docs/content/reference/d2vm_run_qemu.md'; echo "Please regenerate the documentation with 'make docs'"; exit 1)
|
@git diff --quiet -- docs ':(exclude)docs/content/reference/d2vm_run_qemu.md' || (git --no-pager diff -- docs ':(exclude)docs/content/reference/d2vm_run_qemu.md'; echo "Please regenerate the documentation with 'make cli-docs'"; exit 1)
|
||||||
|
|
||||||
check-fmt:
|
check-fmt:
|
||||||
@[ "$(gofmt -l $(find . -name '*.go') 2>&1)" = "" ]
|
@[ "$(gofmt -l $(find . -name '*.go') 2>&1)" = "" ]
|
||||||
|
24
README.md
24
README.md
@ -154,20 +154,21 @@ Usage:
|
|||||||
|
|
||||||
Flags:
|
Flags:
|
||||||
--append-to-cmdline string Extra kernel cmdline arguments to append to the generated one
|
--append-to-cmdline string Extra kernel cmdline arguments to append to the generated one
|
||||||
-f, --force Override output qcow2 image
|
--force Override output qcow2 image
|
||||||
-h, --help help for convert
|
-h, --help help for convert
|
||||||
--network-manager string Network manager to use for the image: none, netplan, ifupdown
|
--network-manager string Network manager to use for the image: none, netplan, ifupdown
|
||||||
-o, --output string The output image, the extension determine the image format, raw will be used if none. Supported formats: qcow2 qed raw vdi vhd vmdk (default "disk0.qcow2")
|
-o, --output string The output image, the extension determine the image format, raw will be used if none. Supported formats: qcow2 qed raw vdi vhd vmdk (default "disk0.qcow2")
|
||||||
-p, --password string The Root user password (default "root")
|
-p, --password string Optional root user password
|
||||||
--pull Always pull docker image
|
--pull Always pull docker image
|
||||||
|
--push Push the container disk image to the registry
|
||||||
--raw Just convert the container to virtual machine image without installing anything more
|
--raw Just convert the container to virtual machine image without installing anything more
|
||||||
-s, --size string The output image size (default "10G")
|
-s, --size string The output image size (default "10G")
|
||||||
|
-t, --tag string Container disk Docker image tag
|
||||||
|
|
||||||
Global Flags:
|
Global Flags:
|
||||||
-t, --time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
--time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
||||||
-v, --verbose Enable Verbose output
|
-v, --verbose Enable Verbose output
|
||||||
|
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Create an image based on the **ubuntu** official image:
|
Create an image based on the **ubuntu** official image:
|
||||||
@ -306,16 +307,18 @@ Flags:
|
|||||||
--append-to-cmdline string Extra kernel cmdline arguments to append to the generated one
|
--append-to-cmdline string Extra kernel cmdline arguments to append to the generated one
|
||||||
--build-arg stringArray Set build-time variables
|
--build-arg stringArray Set build-time variables
|
||||||
-f, --file string Name of the Dockerfile
|
-f, --file string Name of the Dockerfile
|
||||||
--force Override output image
|
--force Override output qcow2 image
|
||||||
-h, --help help for build
|
-h, --help help for build
|
||||||
--network-manager string Network manager to use for the image: none, netplan, ifupdown
|
--network-manager string Network manager to use for the image: none, netplan, ifupdown
|
||||||
-o, --output string The output image, the extension determine the image format, raw will be used if none. Supported formats: qcow2 qed raw vdi vhd vmdk (default "disk0.qcow2")
|
-o, --output string The output image, the extension determine the image format, raw will be used if none. Supported formats: qcow2 qed raw vdi vhd vmdk (default "disk0.qcow2")
|
||||||
-p, --password string Root user password (default "root")
|
-p, --password string Optional root user password
|
||||||
|
--push Push the container disk image to the registry
|
||||||
--raw Just convert the container to virtual machine image without installing anything more
|
--raw Just convert the container to virtual machine image without installing anything more
|
||||||
-s, --size string The output image size (default "10G")
|
-s, --size string The output image size (default "10G")
|
||||||
|
-t, --tag string Container disk Docker image tag
|
||||||
|
|
||||||
Global Flags:
|
Global Flags:
|
||||||
-t, --time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
--time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
||||||
-v, --verbose Enable Verbose output
|
-v, --verbose Enable Verbose output
|
||||||
|
|
||||||
```
|
```
|
||||||
@ -330,6 +333,13 @@ Or if you want to create a VirtualBox image:
|
|||||||
sudo d2vm build -p MyP4Ssw0rd -f ubuntu.Dockerfile -o ubuntu.vdi .
|
sudo d2vm build -p MyP4Ssw0rd -f ubuntu.Dockerfile -o ubuntu.vdi .
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### KubeVirt Container Disk Images
|
||||||
|
|
||||||
|
Using the `--tag` flag with the `build` and `convert` commands, you can create a
|
||||||
|
[Container Disk Image](https://kubevirt.io/user-guide/virtual_machines/disks_and_volumes/#containerdisk) for [KubeVirt](https://kubevirt.io/).
|
||||||
|
|
||||||
|
The `--push` flag will push the image to the registry.
|
||||||
|
|
||||||
### Complete example
|
### Complete example
|
||||||
|
|
||||||
A complete example setting up a ZSH workstation is available in the [examples/full](examples/full/README.md) directory.
|
A complete example setting up a ZSH workstation is available in the [examples/full](examples/full/README.md) directory.
|
||||||
|
@ -6,7 +6,7 @@
|
|||||||
|
|
||||||
```
|
```
|
||||||
-h, --help help for d2vm
|
-h, --help help for d2vm
|
||||||
-t, --time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
--time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
||||||
-v, --verbose Enable Verbose output
|
-v, --verbose Enable Verbose output
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -12,19 +12,21 @@ d2vm build [context directory] [flags]
|
|||||||
--append-to-cmdline string Extra kernel cmdline arguments to append to the generated one
|
--append-to-cmdline string Extra kernel cmdline arguments to append to the generated one
|
||||||
--build-arg stringArray Set build-time variables
|
--build-arg stringArray Set build-time variables
|
||||||
-f, --file string Name of the Dockerfile
|
-f, --file string Name of the Dockerfile
|
||||||
--force Override output image
|
--force Override output qcow2 image
|
||||||
-h, --help help for build
|
-h, --help help for build
|
||||||
--network-manager string Network manager to use for the image: none, netplan, ifupdown
|
--network-manager string Network manager to use for the image: none, netplan, ifupdown
|
||||||
-o, --output string The output image, the extension determine the image format, raw will be used if none. Supported formats: qcow2 qed raw vdi vhd vmdk (default "disk0.qcow2")
|
-o, --output string The output image, the extension determine the image format, raw will be used if none. Supported formats: qcow2 qed raw vdi vhd vmdk (default "disk0.qcow2")
|
||||||
-p, --password string Optional root user password
|
-p, --password string Optional root user password
|
||||||
|
--push Push the container disk image to the registry
|
||||||
--raw Just convert the container to virtual machine image without installing anything more
|
--raw Just convert the container to virtual machine image without installing anything more
|
||||||
-s, --size string The output image size (default "10G")
|
-s, --size string The output image size (default "10G")
|
||||||
|
-t, --tag string Container disk Docker image tag
|
||||||
```
|
```
|
||||||
|
|
||||||
### Options inherited from parent commands
|
### Options inherited from parent commands
|
||||||
|
|
||||||
```
|
```
|
||||||
-t, --time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
--time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
||||||
-v, --verbose Enable Verbose output
|
-v, --verbose Enable Verbose output
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -17,7 +17,7 @@ See each sub-command's help for details on how to use the generated script.
|
|||||||
### Options inherited from parent commands
|
### Options inherited from parent commands
|
||||||
|
|
||||||
```
|
```
|
||||||
-t, --time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
--time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
||||||
-v, --verbose Enable Verbose output
|
-v, --verbose Enable Verbose output
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -40,7 +40,7 @@ d2vm completion bash
|
|||||||
### Options inherited from parent commands
|
### Options inherited from parent commands
|
||||||
|
|
||||||
```
|
```
|
||||||
-t, --time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
--time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
||||||
-v, --verbose Enable Verbose output
|
-v, --verbose Enable Verbose output
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -31,7 +31,7 @@ d2vm completion fish [flags]
|
|||||||
### Options inherited from parent commands
|
### Options inherited from parent commands
|
||||||
|
|
||||||
```
|
```
|
||||||
-t, --time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
--time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
||||||
-v, --verbose Enable Verbose output
|
-v, --verbose Enable Verbose output
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -28,7 +28,7 @@ d2vm completion powershell [flags]
|
|||||||
### Options inherited from parent commands
|
### Options inherited from parent commands
|
||||||
|
|
||||||
```
|
```
|
||||||
-t, --time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
--time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
||||||
-v, --verbose Enable Verbose output
|
-v, --verbose Enable Verbose output
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -38,7 +38,7 @@ d2vm completion zsh [flags]
|
|||||||
### Options inherited from parent commands
|
### Options inherited from parent commands
|
||||||
|
|
||||||
```
|
```
|
||||||
-t, --time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
--time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
||||||
-v, --verbose Enable Verbose output
|
-v, --verbose Enable Verbose output
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -10,20 +10,22 @@ d2vm convert [docker image] [flags]
|
|||||||
|
|
||||||
```
|
```
|
||||||
--append-to-cmdline string Extra kernel cmdline arguments to append to the generated one
|
--append-to-cmdline string Extra kernel cmdline arguments to append to the generated one
|
||||||
-f, --force Override output qcow2 image
|
--force Override output qcow2 image
|
||||||
-h, --help help for convert
|
-h, --help help for convert
|
||||||
--network-manager string Network manager to use for the image: none, netplan, ifupdown
|
--network-manager string Network manager to use for the image: none, netplan, ifupdown
|
||||||
-o, --output string The output image, the extension determine the image format, raw will be used if none. Supported formats: qcow2 qed raw vdi vhd vmdk (default "disk0.qcow2")
|
-o, --output string The output image, the extension determine the image format, raw will be used if none. Supported formats: qcow2 qed raw vdi vhd vmdk (default "disk0.qcow2")
|
||||||
-p, --password string Optional root user password
|
-p, --password string Optional root user password
|
||||||
--pull Always pull docker image
|
--pull Always pull docker image
|
||||||
|
--push Push the container disk image to the registry
|
||||||
--raw Just convert the container to virtual machine image without installing anything more
|
--raw Just convert the container to virtual machine image without installing anything more
|
||||||
-s, --size string The output image size (default "10G")
|
-s, --size string The output image size (default "10G")
|
||||||
|
-t, --tag string Container disk Docker image tag
|
||||||
```
|
```
|
||||||
|
|
||||||
### Options inherited from parent commands
|
### Options inherited from parent commands
|
||||||
|
|
||||||
```
|
```
|
||||||
-t, --time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
--time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
||||||
-v, --verbose Enable Verbose output
|
-v, --verbose Enable Verbose output
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -11,7 +11,7 @@ Run the virtual machine image
|
|||||||
### Options inherited from parent commands
|
### Options inherited from parent commands
|
||||||
|
|
||||||
```
|
```
|
||||||
-t, --time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
--time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
||||||
-v, --verbose Enable Verbose output
|
-v, --verbose Enable Verbose output
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -20,7 +20,7 @@ d2vm run hetzner [options] image-path [flags]
|
|||||||
### Options inherited from parent commands
|
### Options inherited from parent commands
|
||||||
|
|
||||||
```
|
```
|
||||||
-t, --time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
--time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
||||||
-v, --verbose Enable Verbose output
|
-v, --verbose Enable Verbose output
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -28,7 +28,7 @@ d2vm run qemu [options] [image-path] [flags]
|
|||||||
### Options inherited from parent commands
|
### Options inherited from parent commands
|
||||||
|
|
||||||
```
|
```
|
||||||
-t, --time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
--time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
||||||
-v, --verbose Enable Verbose output
|
-v, --verbose Enable Verbose output
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -22,7 +22,7 @@ d2vm run vbox [options] image-path [flags]
|
|||||||
### Options inherited from parent commands
|
### Options inherited from parent commands
|
||||||
|
|
||||||
```
|
```
|
||||||
-t, --time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
--time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
||||||
-v, --verbose Enable Verbose output
|
-v, --verbose Enable Verbose output
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -15,7 +15,7 @@ d2vm version [flags]
|
|||||||
### Options inherited from parent commands
|
### Options inherited from parent commands
|
||||||
|
|
||||||
```
|
```
|
||||||
-t, --time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
--time string Enable formated timed output, valide formats: 'relative (rel | r)', 'full (f)' (default "none")
|
||||||
-v, --verbose Enable Verbose output
|
-v, --verbose Enable Verbose output
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user