├── .gitignore ├── LICENSE ├── README.md ├── docs ├── FAQ.md ├── README.md ├── downloads.md ├── getting-started.md └── kind.md └── man ├── vctl.md ├── vctl_build.md ├── vctl_create.md ├── vctl_describe.md ├── vctl_exec.md ├── vctl_execvm.md ├── vctl_images.md ├── vctl_inspect.md ├── vctl_kind.md ├── vctl_login.md ├── vctl_logout.md ├── vctl_ps.md ├── vctl_pull.md ├── vctl_push.md ├── vctl_rm.md ├── vctl_rmi.md ├── vctl_run.md ├── vctl_start.md ├── vctl_stop.md ├── vctl_system.md ├── vctl_system_config.md ├── vctl_system_info.md ├── vctl_system_start.md ├── vctl_system_stop.md ├── vctl_tag.md ├── vctl_version.md ├── vctl_volume.md └── vctl_volume_prune.md /.gitignore: -------------------------------------------------------------------------------- 1 | **/.DS_Store 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright 2022 VMware 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 4 | 5 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 6 | 7 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 8 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # VMware Fusion and Workstation Container Runtime Docs 2 | 3 | [![asciicast](https://asciinema.org/a/iPMELQH4kHA5sL721CtYTxU7e.svg)](https://asciinema.org/a/iPMELQH4kHA5sL721CtYTxU7e) 4 | 5 | Quick Link: 6 | - [Getting Started Guide](./docs/getting-started.md) 7 | 8 | ## What is vctl? 9 | 10 | vctl is a command line utility for managing containers and the associated VMware container runtime (formerlly 'Project Nautilus'). 11 | vctl allows users to Build, Run, Push and Pull containers and images, manage the system runtime settings, and configure the environment to support 'kind'. 12 | 13 | ## How do I install vctl? 14 | 15 | 'vctl' is included with Fusion 11.5.5 and newer. Fusion 12 adds the additional capability to run 'kind' kubernetes clusters. The 'vctl' command line tool is added to $PATH by default each time Fusion starts, and does not need to be installed seperately. 16 | 17 | For convenience, VMware Fusion can be installed via Homebrew: 18 | 19 | ` brew install vmware-fusion ` 20 | 21 | ## Can I try vctl before buying Fusion or Workstation? 22 | Fusion Pro and Workstation Pro each include a built-in 30 day trial license. 23 | Fusion Player or Workstation Player can be licensed for Personal Use for no cost. 24 | 25 | You can download Fusion and Workstation directly from here: 26 | 27 | - [vmware.com/go/tryfusion](https://vmware.com/go/tryfusion) 28 | - [vmware.com/go/tryworkstation](https://vmware.com/go/tryworkstation) 29 | - [vmware.com/go/downloadworkstationplayer](https://www.vmware.com/go/downloadworkstationplayer) 30 | 31 | 32 | ## What are the System Requirements? 33 | 34 | VMware Fusion system requirements are located ***[here](https://vmware.com/go/fusion-relnotes)*** 35 | VMware Workstation requirements are located ***[here](hhttps://vmware.com/go/ws-relnotes)*** 36 | 37 | 38 | ## How do I get started? 39 | 40 | You can check out our Getting Started guide ***[here](./docs/getting-started.md)*** 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | -------------------------------------------------------------------------------- /docs/FAQ.md: -------------------------------------------------------------------------------- 1 | # vctl FAQs 2 | 3 | ### How many containers can I run at the same time in my mac 4 | 5 | This depends on your host memory and the nature of your container application. The container appliance only consumes as much memory as the services within it request. 6 | 7 | ### How does vctl pass an entrypoint command to container 8 | 9 | If no argument is passed to the 'vctl run container' command, by default the image's entrypoint command will be invoked. 10 | 11 | If there are arguments provided, unlike 'docker run' command where the arguments are appended to the image's predefined entrypoint command, in 'vctl run container', they themselves will be treated as the container's entrypoint command and replace the image's predefined one, to be invoked directly. 12 | 13 | 14 | ### How to reset my environment? 15 | 16 | As a troubleshooting measure, you may choose to reset your container environment. 17 | Note that proceeding with the following steps, any container and image data will be lost. 18 | 19 | ``` 20 | > vctl system stop --force 21 | ``` 22 | 23 | This command will remove all existing container images and storage (use with caution!) 24 | 25 | ``` 26 | > rm -rf ~/.vctl 27 | 28 | > vctl system start 29 | ``` 30 | -------------------------------------------------------------------------------- /docs/README.md: -------------------------------------------------------------------------------- 1 | # VMware Fusion and Workstation Docs for 'vctl' 2 | 3 | [Getting Started Guide](./getting-started.md) 4 | 5 | [Frequently Asked Questions](./FAQ.md) 6 | 7 | [man pages](../man/) 8 | 9 | -------------------------------------------------------------------------------- /docs/downloads.md: -------------------------------------------------------------------------------- 1 | # Download locations 2 | 3 | vctl is included with VMware Fusion 12 and Workstation 16, both Pro and Player. 4 | 5 | 6 | ## Fusion 12 Pro 7 | 8 | **Direct Download (Pro and Player:** 9 | - [vmware.com/go/getfusion](https://www.vmware.com/go/getfusion) 10 | 11 | **MyVMware Downloads** 12 | - [MyVMware](https://www.vmware.com/go/downloadfusion) 13 | 14 | ## Fusion 12 Player: 15 | 16 | Register for Personal Use License: 17 | - [vmware.com/go/get-fusionplayer-key](https://www.vmware.com/go/get-fusionplayer-key) 18 | 19 | 20 | Additionally, Fusion can be installed via [Homebrew](https://formulae.brew.sh/cask/vmware-fusion). 21 | After installation, it is recommended to launch the UI to complete the initialization steps, and to license the product. 22 | 23 | ` brew cask install vmware-fusion` 24 | 25 | *Note that homebrew installations are officially unsupported.* 26 | 27 | ## Workstation 16 Pro 28 | 29 | **Direct Download:** 30 | 31 | - Windows: [vmware.com/go/getworkstation-win](https://www.vmware.com/go/getworkstation-win) 32 | - Linux: [vmware.com/go/getworkstation-linux](https://www.vmware.com/go/getworkstation-linux) 33 | 34 | **MyVMware Downloads** 35 | - [MyVMware](https://www.vmware.com/go/downloadworkstation) 36 | 37 | **Evaluate Workstation Pro** 38 | [vmware.com/go/tryworkstation](https://www.vmware.com/go/tryworkstation) 39 | 40 | VMware Workstation can also be installed with [Chocolatey](https://chocolatey.org/packages/vmwareworkstation) 41 | 42 | From a cmd.exe or PowerShell prompt: 43 | 44 | `choco install vmwareworkstation` 45 | 46 | If you have an existing installation: 47 | `choco upgrade vmwareworkstation` 48 | 49 | *Note that chocolaty installations are officially unsupported.* 50 | 51 | ## Workstation 16 Player: 52 | 53 | Download (Perrsonal Use License is built-in): 54 | - Windows: [vmware.com/go/getplayer-win](https://www.vmware.com/go/getplayer-win) 55 | - Linux: [vmware.com/go/getplayer-linux](https://www.vmware.com/go/getplayer-linux) 56 | 57 | 58 | -------------------------------------------------------------------------------- /docs/getting-started.md: -------------------------------------------------------------------------------- 1 | # Getting Started with vctl on Fusion and Workstation 2 | 3 | the vctl CLI is included with VMware Fusion 12 and VMware Workstation 16, both Pro and Player. Fusion 11.5.x will continue to ship the previous version of vctl, but will differ in capability from Fusion 12. 4 | 5 | ### Install Fusion 12 or Workstation 16 6 | Fusion and Workstation download links and installation instructions can be found [here](downloads.md) 7 | 8 | ### Start the vctl service 9 | 10 | The first operation is to start the container runtime. On first launch, `vctl system start` will automatically prepare the system with the dependenceis it needs, including: 11 | 12 | - Creating a case-sensitive volume for storing container images 13 | - you can see this mounted on your desktop once the services start, and you can access the contents directly 14 | - Creating a container network using vmnet 15 | - launching the container runtime system service 16 | 17 | 18 | ``` 19 | > vctl system start 20 | 21 | Preparing storage... 22 | Container storage has been prepared successfully under /Users/mike/.vctl/storage 23 | Preparing container network, you may be prompted to input password for administrative operations... 24 | Password: 25 | Container network has been prepared successfully using vmnet: vmnet16 26 | Launching container runtime... 27 | Container runtime has been started. 28 | 29 | ``` 30 | 31 | 32 | If you prefer you can also customize the preparation. This will allow you to set new defaults for the container appliance vm size, as well as the size of the container storage volume. 33 | 34 | You can also specify these parameters when executing `vctl run` by using the **-c** and **-m** flags. 35 | 36 | 37 | ``` 38 | USAGE: 39 | vctl system config [OPTIONS] 40 | 41 | OPTIONS: 42 | --cache-location string Specify the cache file location (default "/Users/mike/.vctl") 43 | -h, --help Help for config 44 | --mount-name string Mount name for container storage (default "Fusion Container Storage") 45 | -s, --storage string Container storage size (default "128g") 46 | -c, --vm-cpus int CPU cores of base virtual machine that hosts container (default 2) 47 | -m, --vm-mem int Memory size (MB) for virtual machine that hosts container (default 1024) 48 | 49 | EXAMPLES: 50 | # To configure the virtual machine that hosts container with 4 CPU cores and 2GB memory by default. 51 | vctl system config --vm-cpus 4 --vm-mem 2048 52 | 53 | ``` 54 | 55 | 56 | ### vctl commands 57 | You can type `vctl` with no arguments to get a list of commands available to run containers. 58 | 59 | ``` 60 | USAGE: 61 | vctl COMMAND [OPTIONS] 62 | 63 | COMMANDS: 64 | build Build a container image from a Dockerfile. 65 | create Create a new container from a container image. 66 | describe Show details of a container. 67 | exec Execute a command within a running container. 68 | execvm Execute a command within a running virtual machine that hosts container. 69 | help Help about any command. 70 | images List container images. 71 | ps List containers. 72 | pull Pull a container image from a registry. 73 | push Push a container image to a registry. 74 | rm Remove one or more containers. 75 | rmi Remove one or more container images. 76 | run Run a new container from a container image. 77 | start Start an existing container. 78 | stop Stop a container. 79 | system Manage the Container Engine. 80 | tag Tag container images. 81 | version Print the version of vctl. 82 | 83 | Run 'vctl COMMAND --help' for more information on a command. 84 | ``` 85 | 86 | 87 | 88 | ### Pull an image from a remote registry 89 | To run a container, you will firstly need to get an image from a repository, or you'll need to build one from a Dockerfile. Images are by default pulled from dockerhub, but a private image registry such as Harbor can be used as well. 90 | 91 | ``` 92 | > vctl pull nginx 93 | INFO Pulling from index.docker.io/library/nginx:latest 94 | ─── ────── ──────── 95 | REF STATUS PROGRESS 96 | ─── ────── ──────── 97 | index-sha256:30dfa439718a17baafefadf16c5e7c9d0a1cde97b4fd84f63b69e13513be7097 Done 100% (1412/1412) 98 | manifest-sha256:8269a7352a7dad1f8b3dc83284f195bac72027dd50279422d363d49311ab7d9b Done 100% (948/948) 99 | layer-sha256:11fa52a0fdc084d7fc3bbcb774389fd37b148ee98e7829cea4af189735acf848 Done 100% (203/203) 100 | layer-sha256:afb6ec6fdc1c3ba04f7a56db32c5ff5ff38962dc4cd0ffdef5beaa0ce2eb77e2 Done 100% (27098756/27098756) 101 | config-sha256:9beeba249f3ee158d3e495a6ac25c5667ae2de8a43ac2a8bfd2bf687a58c06c9 Done 100% (6670/6670) 102 | layer-sha256:b90c53a0b69244e37b3f8672579fc3dec13293eeb574fa0fdddf02da1e192fd6 Done 100% (23922586/23922586) 103 | INFO Unpacking nginx:latest... 104 | INFO done 105 | ``` 106 | 107 | ### Log in to a remote registry 108 | 109 | vctl now supports a persistent login to a private remote container registery. 110 | ``` 111 | USAGE: 112 | vctl login [OPTIONS] [SERVER] 113 | ``` 114 | 115 | `> vctl login -u username -p password myregistry:5000` 116 | 117 | 118 | By default it will attempt to login to dockerhub, but you can specify a compatible registry like [Harbor](https://goharbor.io) via fqdn: 119 | 120 | `vctl login` also supports stdin with the `--password-stdin` flag 121 | 122 | `> cat /path/to/password.txt | vctl login -u username -p password --password-stdin 123 | 124 | 125 | 126 | ### Build a new container image 127 | 128 | You can use a standard dockerfile to build a new container image, rather than downloading a pre-packaged one. vctl also supports multi-stage builds. The process to simply `cd` into a directory with a `Dockerfile` and executing `vctl build .` 129 | 130 | ``` 131 | > vctl build -t myImage:latest . 132 | vctl build -t myImage:latest . 133 | INFO building image myImage:latest with jobId 92f6eea9-2892-4400-ba5c-b83412f5100c using internal builder instance... 134 | INFO preparing base images... 135 | 136 | ... (full stack omitted for brevity) 137 | 138 | INFO[0018] Taking snapshot of files... 139 | INFO[0018] Generating final image file... 140 | INFO[0019] Finished generating final image file 141 | INFO creating image myImage:latest 142 | INFO successfully built image myImage:latest 143 | 144 | ``` 145 | 146 | ### Run the container image 147 | Once the image has been built or pulled locally, you can run it as a new container. Here we're also specifying the '-d' flag which detaches the host console session from the running container. 148 | 149 | ``` 150 | USAGE: 151 | vctl run [OPTIONS] IMAGE [COMMAND] [ARGUMENTS...] 152 | ``` 153 | 154 | ``` 155 | > vctl run -n myNginx -t -d nginx 156 | INFO container myNginx started and detached from current session 157 | 158 | ``` 159 | 160 | ### Verify the container is running 161 | 162 | You can now see the container status as 'running' with `vctl ps`: 163 | 164 | ``` 165 | > vctl ps 166 | ──── ───── ─────── ── ───── ────── ───────────── 167 | NAME IMAGE COMMAND IP PORTS STATUS CREATION TIME 168 | ──── ───── ─────── ── ───── ────── ───────────── 169 | myNginx nginx:latest nginx -g daemon off; 192.168.243.128 n/a running 2020-05-28T15:29:51-07:00 170 | ``` 171 | 172 | To get a full list of containers, including those are not running, you can add the **-a** flag: 173 | 174 | 175 | ``` 176 | > vctl ps -a 177 | ──── ───── ─────── ── ───── ────── ───────────── 178 | NAME IMAGE COMMAND IP PORTS STATUS CREATION TIME 179 | ──── ───── ─────── ── ───── ────── ───────────── 180 | myImage myImage:latest nginx -g daemon off; n/a n/a stopped 2020-05-28T16:10:27-07:00 181 | myNginx nginx:latest nginx -g daemon off; 192.168.243.128 n/a running 2020-05-28T15:29:51-07:00 182 | ``` 183 | 184 | Now you can launch a web browser to navigate to the IP of the nginx container appliance (192.168.243.128 in the case of the example above) which is now up and running. No need to map ports unless you want to. 185 | 186 | 187 | ### Stop/Start the container 188 | You can stop the container to free up resources with following command: 189 | 190 | ``` 191 | > vctl stop myNginx 192 | INFO container myNginx has been stopped 193 | ``` 194 | 195 | You can re-start a stopped container with start command: 196 | 197 | ``` 198 | > vctl start myNginx -d 199 | INFO container myNginx started and detached from current session 200 | ``` 201 | 202 | ### List images 203 | 204 | vctl provides a familiar way to show images and containers. Use `vctl images` to show info about the local stored images 205 | 206 | ``` 207 | > vctl images 208 | ──── ───────────── ──── 209 | NAME CREATION TIME SIZE 210 | ──── ───────────── ──── 211 | nginx:latest 2020-05-28T15:29:26-07:00 48.7 MiB 212 | ``` 213 | 214 | 215 | ### Using kind Kubernetes with vctl 216 | 217 | vctl provides a way to alias docker commands to run on the vctl containerd runtime. 218 | For more information, review this document: [kind](kind.md) 219 | 220 | 221 | ### Advanced Use Cases 222 | 223 | You can use `vctl describe` to get more detailed information of a container, the virtual machine that hosts this container, rootfs of the container and more: 224 | 225 | ``` 226 | > vctl describe myNginx 227 | Name: myNginx 228 | Status: running 229 | Command: nginx -g daemon off; 230 | Container rootfs in host: /Users/mike/.vctl/storage/containerd/state/io.containerd.runtime.v2.task/vctl/myNginx/rootfs 231 | IP address: 192.168.243.128 232 | Creation time: 2020-05-28T15:29:51-07:00 233 | Image name: nginx:latest 234 | Image size: 48.7 MiB 235 | Host virtual machine: /Users/mike/.vctl/.r/vms/myNginx/myNginx.vmx 236 | Container rootfs in VM: /.containers/myNginx 237 | Access in host VM: vctl execvm --sh -c myNginx 238 | Exec in host VM: vctl execvm -c myNginx /bin/ls 239 | ``` 240 | 241 | 242 | ### Exec into the container 243 | 244 | vctl supports `exec`, meaning you can run commands in the container from the host. You can use this to run one-time commands, or to open an interactive shell. Also supports the **-d** flag to detach from the current terminal (i.e. whatever command you exec will run in the container but not display output to the current terminal) 245 | 246 | Examples: 247 | 248 | Interactivly: 249 | ``` 250 | > vctl exec -it myNginx sh 251 | # ls 252 | bin boot dev etc home lib lib64 media mnt opt proc root run sbin srv sys tmp usr var 253 | ``` 254 | 255 | or: 256 | 257 | ``` 258 | > vctl exec myNginx ls 259 | bin 260 | boot 261 | dev 262 | etc 263 | home 264 | lib 265 | lib64 266 | media 267 | mnt 268 | opt 269 | proc 270 | root 271 | run 272 | sbin 273 | srv 274 | sys 275 | tmp 276 | usr 277 | var 278 | ``` 279 | 280 | ### Shell access into the container appliance VM 281 | 282 | vctl has the ability to shell into the container appliance (virtual machine) of the specified container. 283 | 284 | Example: 285 | 286 | ``` 287 | > vctl execvm --sh -c myNginx 288 | sh-4.4# 289 | ``` 290 | 291 | 292 | 293 | ### Keep the VM running after container stopped 294 | 295 | By adding the "-k" parameter when running a container, when the container exits its appliance vm will keep running. You can still `vctl execvm --sh` into the container host to inspect logs and other debug info. 296 | -------------------------------------------------------------------------------- /docs/kind.md: -------------------------------------------------------------------------------- 1 | # Using kind with vctl 2 | 3 | VMware Fusion 12 and Workstation 16, Pro and Player, both ship with the ability for 'vctl' to be used to deploy kind based kubernetes clusters. 4 | 5 | The way vctl implements this is by creating an alias to the docker CLI used by kind to manage the lifecycle of the cluster. From there, kind handles all the rest. 6 | 7 | ## How to use 8 | Firstly, make sure the container runtime has been started: 9 | 10 | `> vctl system start` 11 | 12 | Once the runtime has started, use the following command: 13 | 14 | `> vctl kind` 15 | 16 | The output should look like this: 17 | ``` 18 | > vctl kind 19 | Downloading 3 files... 20 | Downloading [crx.vmdk 38.59% kubectl 86.57% kind-darwin-amd64 1.56%] 21 | Finished kubectl 100.00% 22 | Downloading [crx.vmdk 64.98% kind-darwin-amd64 40.06%] 23 | Finished kind-darwin-amd64 100.00% 24 | Downloading [crx.vmdk 93.05%] 25 | Finished crx.vmdk 100.00% 26 | 3 files successfully downloaded. 27 | 28 | vctl-based KIND is ready now. KIND will run local Kubernetes clusters by using vctl containers as "nodes" 29 | 30 | * All Docker commands have been aliased to vctl in the current terminal. Docker commands performed in current window would be executed through vctl. 31 | ``` 32 | 33 | `vctl kind` does 2 things: 34 | 1) It downloads the necessary components if they are not present 35 | 36 | - kubectl 37 | - kind for macOS 38 | - the 'crx' virtual appliance container host environment, specifically tuned for `kind` 39 | 40 | 2) It creates an alias of the docker executable to instead use 'vctl'. 41 | ``` 42 | > which docker 43 | /Users/mike/.vctl/bin/docker 44 | ``` 45 | ## Okay, now what? 46 | 47 | From here, the rest is standard [kind operations](https://kind.sigs.k8s.io/docs/user/quick-start/). 48 | 49 | For example, you can create a basic cluster with: 50 | 51 | `> kind create cluster` 52 | 53 | ## Loading an image into a kind cluster 54 | 55 | vctl supports auto-loading of a container image into an existing kind cluster at build time. 56 | what this means is you can use the following: 57 | 58 | `> vctl build -t image:tag --kind-load .` 59 | 60 | If you have already pulled the image from some place, instead of bulding it directly, you can use the `kind load docker-image` command: 61 | 62 | `> kind load docker-image image:tag` 63 | 64 | Once the image is in the cluster, you can run it directly, or apply a .yaml file that uses that image. 65 | 66 | `> kubectl run --image image:tag --restart=Never --image-pull-policy=Never my-pod-name` 67 | 68 | 69 | 70 | -------------------------------------------------------------------------------- /man/vctl.md: -------------------------------------------------------------------------------- 1 | ## vctl 2 | 3 | vctl - A CLI tool for the container engine powered by VMware Fusion 4 | 5 | ### Synopsis 6 | 7 | vctl Highlights: 8 | • Build and run OCI containers. 9 | • Push and pull container images between remote registries & local storage. 10 | • Use a lightweight virtual machine (CRX VM) based on VMware Photon OS to host a container. Use 'vctl system config -h' to learn more. 11 | • Easy shell access into virtual machine that hosts container. See 'vctl execvm’. 12 | 13 | ### Options 14 | 15 | ``` 16 | -h, --help Help for vctl 17 | ``` 18 | 19 | ### SEE ALSO 20 | 21 | * [vctl build](vctl_build.md) - Build a container image from a Dockerfile. 22 | * [vctl create](vctl_create.md) - Create a new container from a container image. 23 | * [vctl describe](vctl_describe.md) - Show details of a container. 24 | * [vctl exec](vctl_exec.md) - Execute a command within a running container. 25 | * [vctl execvm](vctl_execvm.md) - Execute a command within a running virtual machine that hosts container. 26 | * [vctl images](vctl_images.md) - List container images. 27 | * [vctl inspect](vctl_inspect.md) - Return low-level information on objects. 28 | * [vctl kind](vctl_kind.md) - Get system environment ready for vctl-based KIND. 29 | * [vctl login](vctl_login.md) - Log in to a registry. 30 | * [vctl logout](vctl_logout.md) - Log out from a registry. 31 | * [vctl ps](vctl_ps.md) - List containers. 32 | * [vctl pull](vctl_pull.md) - Pull a container image from a registry. 33 | * [vctl push](vctl_push.md) - Push a container image to a registry. 34 | * [vctl rm](vctl_rm.md) - Remove one or more containers. 35 | * [vctl rmi](vctl_rmi.md) - Remove one or more container images. 36 | * [vctl run](vctl_run.md) - Run a new container from a container image. 37 | * [vctl start](vctl_start.md) - Start an existing container. 38 | * [vctl stop](vctl_stop.md) - Stop a container. 39 | * [vctl system](vctl_system.md) - Manage the container engine. 40 | * [vctl tag](vctl_tag.md) - Tag container images. 41 | * [vctl version](vctl_version.md) - Print the version of vctl. 42 | * [vctl volume](vctl_volume.md) - Manage volumes. 43 | 44 | ###### Auto generated by spf13/cobra on 14-Sep-2020 45 | -------------------------------------------------------------------------------- /man/vctl_build.md: -------------------------------------------------------------------------------- 1 | ## vctl build 2 | 3 | Build a container image from a Dockerfile. 4 | 5 | ### Synopsis 6 | 7 | Build an OCI compliant container image from the given PATH, and store it in the local container storage volume. 8 | * A random name will be assigned to the container image to build if '--tag' is not used. 9 | 10 | ``` 11 | vctl build [OPTIONS] PATH 12 | ``` 13 | 14 | ### Examples 15 | 16 | ``` 17 | # To use current directory as the build context. (Dockerfile will be used for the build instruction by default; a random name will be assigned to the image to build.) 18 | vctl build . 19 | 20 | # To specify file Dockerfile.test for the build instructions and /Users/username/myapp as root of build context. 21 | vctl build -f Dockerfiles/Dockerfile.test /Users/username/myapp 22 | 23 | # To tag the image using mynamespace/myrepo:1.0 as name after building. 24 | vctl build --tag mynamespace/myrepo:1.0 . 25 | 26 | # To load the image into a local kind cluster in current kubectl context after building. 27 | vctl build -t myImage --kind-load . 28 | ``` 29 | 30 | ### Options 31 | 32 | ``` 33 | --builder-mem string Limit on memory (MB/GB) available to the container (default "4g") 34 | -c, --credential string Path to the file storing private registry authentication credentials 35 | -f, --file string Path to the target Dockerfile to build from (Default: PATH/Dockerfile) 36 | -h, --help Help for build 37 | --kind-load Load the image to local kind cluster 38 | --no-local-cache Do not use local storage as cache for base image 39 | -t, --tag string Name of the container image to build 40 | ``` 41 | 42 | ### SEE ALSO 43 | 44 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 45 | 46 | ###### Auto generated by spf13/cobra on 14-Sep-2020 47 | -------------------------------------------------------------------------------- /man/vctl_create.md: -------------------------------------------------------------------------------- 1 | ## vctl create 2 | 3 | Create a new container from a container image. 4 | 5 | ### Synopsis 6 | 7 | Create a container with the given name, from the specified container image. 8 | 9 | ``` 10 | vctl create [OPTIONS] IMAGE [COMMAND] [ARGUMENTS...] 11 | ``` 12 | 13 | ### Options 14 | 15 | ``` 16 | --entrypoint string Override the default entrypoint of the container image 17 | -e, --env strings Environment variables to set in the container 18 | -h, --help Help for create 19 | --hostname string Host name of the container 20 | -i, --interactive Keep STDIN open even if not attached 21 | -l, --label strings Set additional labels to the container (e.g. foo=bar) 22 | -n, --name string Assign a name to the container 23 | -r, --privileged Run the container with extended privileges 24 | -p, --publish strings Bind host network ports to container ports 25 | -t, --tty Allocate a terminal for the container 26 | -v, --volume strings Bind host folders to container folders 27 | -w, --workdir string Working directory of the new process 28 | ``` 29 | 30 | ### SEE ALSO 31 | 32 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 33 | 34 | ###### Auto generated by spf13/cobra on 14-Sep-2020 35 | -------------------------------------------------------------------------------- /man/vctl_describe.md: -------------------------------------------------------------------------------- 1 | ## vctl describe 2 | 3 | Show details of a container. 4 | 5 | ### Synopsis 6 | 7 | Print detailed description of the given container and practical information for debug and troubleshooting. 8 | * Guide for quick access to & execution in container-hosting virtual machine is available in output. 9 | 10 | ``` 11 | vctl describe [OPTIONS] CONTAINER 12 | ``` 13 | 14 | ### Options 15 | 16 | ``` 17 | -h, --help Help for describe 18 | ``` 19 | 20 | ### SEE ALSO 21 | 22 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 23 | 24 | ###### Auto generated by spf13/cobra on 14-Sep-2020 25 | -------------------------------------------------------------------------------- /man/vctl_exec.md: -------------------------------------------------------------------------------- 1 | ## vctl exec 2 | 3 | Execute a command within a running container. 4 | 5 | ### Synopsis 6 | 7 | Run the given command within the specified container. 8 | 9 | ``` 10 | vctl exec [OPTIONS] CONTAINER COMMAND [ARGUMENTS...] 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # To execute 'top' in container myContainer in background (detached from current terminal). 17 | vctl exec --detach myContainer top 18 | 19 | # To get output from running 'date' command in myContainer. 20 | vctl exec myContainer date 21 | 22 | # To allocate a terminal for myContainer and send stdin to 'bash' in myContainer. 23 | vctl exec -it myContainer bash 24 | ``` 25 | 26 | ### Options 27 | 28 | ``` 29 | -d, --detach Run the command in background 30 | -h, --help Help for exec 31 | -i, --interactive Keep STDIN open even if not attached 32 | -t, --tty Allocate a terminal for the container 33 | ``` 34 | 35 | ### SEE ALSO 36 | 37 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 38 | 39 | ###### Auto generated by spf13/cobra on 14-Sep-2020 40 | -------------------------------------------------------------------------------- /man/vctl_execvm.md: -------------------------------------------------------------------------------- 1 | ## vctl execvm 2 | 3 | Execute a command within a running virtual machine that hosts container. 4 | 5 | ### Synopsis 6 | 7 | Run the given command within the specified virtual machine. 8 | * VMX must be provided with full path (e.g. /Users/user_name/.vctl/.r/vms/mycontainer/mycontainer.vmx). 9 | * Use '--container' to identify the virtual machine which hosts the specified CONTAINER. 10 | * Use '--sh' for easier shell access to a virtual machine. 11 | 12 | ``` 13 | vctl execvm [OPTIONS] (VMX|-c=CONTAINER) COMMAND [ARGUMENTS...] 14 | vctl execvm --sh (VMX|-c=CONTAINER) 15 | ``` 16 | 17 | ### Examples 18 | 19 | ``` 20 | # To identify a virtual machine with the container myContainer that runs in it, and shell into the virtual machine. 21 | vctl execvm --sh -c myContainer 22 | ``` 23 | 24 | ### Options 25 | 26 | ``` 27 | -c, --container string Use container as the identifier of the virtual machine hosting it 28 | -h, --help Help for execvm 29 | -s, --sh Shell into the virtual machine 30 | ``` 31 | 32 | ### SEE ALSO 33 | 34 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 35 | 36 | ###### Auto generated by spf13/cobra on 14-Sep-2020 37 | -------------------------------------------------------------------------------- /man/vctl_images.md: -------------------------------------------------------------------------------- 1 | ## vctl images 2 | 3 | List container images. 4 | 5 | ### Synopsis 6 | 7 | Print basic information about one or more container images. 8 | 9 | ``` 10 | vctl images [OPTIONS] [IMAGE...] 11 | ``` 12 | 13 | ### Options 14 | 15 | ``` 16 | -d, --digests Show digests 17 | -h, --help Help for images 18 | ``` 19 | 20 | ### SEE ALSO 21 | 22 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 23 | 24 | ###### Auto generated by spf13/cobra on 14-Sep-2020 25 | -------------------------------------------------------------------------------- /man/vctl_inspect.md: -------------------------------------------------------------------------------- 1 | ## vctl inspect 2 | 3 | Return low-level information on objects. 4 | 5 | ### Synopsis 6 | 7 | Print detailed information on objects controlled by vctl 8 | * Currently only container is supported. 9 | 10 | ``` 11 | vctl inspect [OPTIONS] NAME 12 | ``` 13 | 14 | ### Examples 15 | 16 | ``` 17 | # To inspect container myContainer 18 | vctl inspect myContainer 19 | ``` 20 | 21 | ### Options 22 | 23 | ``` 24 | -h, --help Help for inspect 25 | ``` 26 | 27 | ### SEE ALSO 28 | 29 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 30 | 31 | ###### Auto generated by spf13/cobra on 14-Sep-2020 32 | -------------------------------------------------------------------------------- /man/vctl_kind.md: -------------------------------------------------------------------------------- 1 | ## vctl kind 2 | 3 | Get system environment ready for vctl-based KIND. 4 | 5 | ### Synopsis 6 | 7 | Using vctl as the provider for KIND instead of Docker, set up system environment to be ready for vctl-based KIND. 8 | * KIND will be downloaded and installed if it's not detected. 9 | * All Docker commands will be aliased to vctl in the current terminal. 10 | * System is only configured for current terminal. All configuration for KIND will be lost when the terminal is closed. 11 | 12 | ``` 13 | vctl kind [OPTIONS] 14 | ``` 15 | 16 | ### Options 17 | 18 | ``` 19 | -h, --help Help for kind 20 | ``` 21 | 22 | ### SEE ALSO 23 | 24 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 25 | 26 | ###### Auto generated by spf13/cobra on 14-Sep-2020 27 | -------------------------------------------------------------------------------- /man/vctl_login.md: -------------------------------------------------------------------------------- 1 | ## vctl login 2 | 3 | Log in to a registry. 4 | 5 | ### Synopsis 6 | 7 | If no server is specified, the default is Docker Hub. 8 | 9 | ``` 10 | vctl login [OPTIONS] [SERVER] 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # To enable insecure registry access using plain HTTP when login to the target registry. 17 | vctl login --http my-plain-http-registry.com:5000 18 | ``` 19 | 20 | ### Options 21 | 22 | ``` 23 | -h, --help Help for login 24 | --http Use plain http to connect remote registry (Default uses https) 25 | -p, --password string Password used to connect remote registry 26 | --password-stdin Read password from stdin 27 | --skip-ssl-check Skip ssl certificate validation 28 | -u, --username string Username used to connect remote registry 29 | ``` 30 | 31 | ### SEE ALSO 32 | 33 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 34 | 35 | ###### Auto generated by spf13/cobra on 14-Sep-2020 36 | -------------------------------------------------------------------------------- /man/vctl_logout.md: -------------------------------------------------------------------------------- 1 | ## vctl logout 2 | 3 | Log out from a registry. 4 | 5 | ### Synopsis 6 | 7 | If no server is specified, the default is Docker Hub. 8 | 9 | ``` 10 | vctl logout [SERVER] 11 | ``` 12 | 13 | ### Options 14 | 15 | ``` 16 | -h, --help Help for logout 17 | ``` 18 | 19 | ### SEE ALSO 20 | 21 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 22 | 23 | ###### Auto generated by spf13/cobra on 14-Sep-2020 24 | -------------------------------------------------------------------------------- /man/vctl_ps.md: -------------------------------------------------------------------------------- 1 | ## vctl ps 2 | 3 | List containers. 4 | 5 | ### Synopsis 6 | 7 | Print basic information about one or more containers. 8 | 9 | ``` 10 | vctl ps [OPTIONS] [CONTAINER...] 11 | ``` 12 | 13 | ### Options 14 | 15 | ``` 16 | -a, --all Show all containers (Default only shows running containers) 17 | -h, --help Help for ps 18 | -l, --label strings Filter containers with additional labels (e.g. foo=bar) 19 | ``` 20 | 21 | ### SEE ALSO 22 | 23 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 24 | 25 | ###### Auto generated by spf13/cobra on 14-Sep-2020 26 | -------------------------------------------------------------------------------- /man/vctl_pull.md: -------------------------------------------------------------------------------- 1 | ## vctl pull 2 | 3 | Pull a container image from a registry. 4 | 5 | ### Synopsis 6 | 7 | Download a container image from remote location and store it locally on host. 8 | * Docker Hub will be used by default if no registry is specified. 9 | * Leave '--password' empty to input your password interactively or use '--password-stdin'. 10 | * ':latest' will be used by default if no tag is specified. 11 | 12 | ``` 13 | vctl pull [OPTIONS] IMAGE 14 | ``` 15 | 16 | ### Examples 17 | 18 | ``` 19 | # To pull nginx from Docker Hub (nginx:latest will be pulled by default). 20 | vctl pull nginx 21 | 22 | # To read the password from a file to access a remote registry repository that needs authentication. (Image will be pulled from Docker Hub by default) 23 | cat mypassword.txt | vctl pull -u myUsername --password-stdin mynamespace/myrepo:latest 24 | ``` 25 | 26 | ### Options 27 | 28 | ``` 29 | -h, --help Help for pull 30 | --http Use plain http to connect remote registry (Default uses https) 31 | -p, --password string Password used to connect remote registry 32 | --password-stdin Read password from stdin 33 | --skip-ssl-check Skip ssl certificate validation 34 | -u, --username string Username used to connect remote registry 35 | ``` 36 | 37 | ### SEE ALSO 38 | 39 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 40 | 41 | ###### Auto generated by spf13/cobra on 14-Sep-2020 42 | -------------------------------------------------------------------------------- /man/vctl_push.md: -------------------------------------------------------------------------------- 1 | ## vctl push 2 | 3 | Push a container image to a registry. 4 | 5 | ### Synopsis 6 | 7 | Upload pre-built container images to a given registry URL. 8 | * If no REMOTE_URL is specified, URL will be inferred from the given IMAGE name, Docker Hub will be used by default if no registry is specified. 9 | * Leave '--password' empty to input your password interactively or use '--password-stdin'. 10 | 11 | ``` 12 | vctl push [OPTIONS] IMAGE [REMOTE_URL] 13 | ``` 14 | 15 | ### Examples 16 | 17 | ``` 18 | # To push local image mynamespace/nginx:latest to Docker Hub. (Registry URL is inferred from the IMAGE) 19 | vctl push mynamespace/nginx:latest 20 | 21 | # To read the password from a file to access a remote registry repository that needs authentication. (Image will be pushed to Docker Hub by default) 22 | cat mypassword.txt | vctl push -u myUsername --password-stdin mynamespace/myrepo:latest 23 | ``` 24 | 25 | ### Options 26 | 27 | ``` 28 | -h, --help Help for push 29 | --http Use plain http to connect remote registry (Default uses https) 30 | -p, --password string Password used to connect remote registry 31 | --password-stdin Read password from stdin 32 | --skip-ssl-check Skip ssl certificate validation 33 | -u, --username string Username used to connect remote registry 34 | ``` 35 | 36 | ### SEE ALSO 37 | 38 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 39 | 40 | ###### Auto generated by spf13/cobra on 14-Sep-2020 41 | -------------------------------------------------------------------------------- /man/vctl_rm.md: -------------------------------------------------------------------------------- 1 | ## vctl rm 2 | 3 | Remove one or more containers. 4 | 5 | ### Synopsis 6 | 7 | Delete all containers or delete by the given container(s). 8 | 9 | ``` 10 | vctl rm [OPTIONS] ([CONTAINER...]|--all) 11 | ``` 12 | 13 | ### Options 14 | 15 | ``` 16 | -a, --all Delete all containers 17 | -f, --force Force removal of container regardless of its status 18 | -h, --help Help for rm 19 | -v, --volume Remove anonymous volume used by the container 20 | ``` 21 | 22 | ### SEE ALSO 23 | 24 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 25 | 26 | ###### Auto generated by spf13/cobra on 14-Sep-2020 27 | -------------------------------------------------------------------------------- /man/vctl_rmi.md: -------------------------------------------------------------------------------- 1 | ## vctl rmi 2 | 3 | Remove one or more container images. 4 | 5 | ### Synopsis 6 | 7 | Delete all images or delete by the given container image(s). 8 | 9 | ``` 10 | vctl rmi [OPTIONS] ([IMAGE...]|--all) 11 | ``` 12 | 13 | ### Options 14 | 15 | ``` 16 | -a, --all Delete all images 17 | -f, --force Force removal of image regardless of its status 18 | -h, --help Help for rmi 19 | ``` 20 | 21 | ### SEE ALSO 22 | 23 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 24 | 25 | ###### Auto generated by spf13/cobra on 14-Sep-2020 26 | -------------------------------------------------------------------------------- /man/vctl_run.md: -------------------------------------------------------------------------------- 1 | ## vctl run 2 | 3 | Run a new container from a container image. 4 | 5 | ### Synopsis 6 | 7 | Create and start a container with the given name, from the specified container image, then run a command in it. 8 | * Every container runs in a separate virtual machine (CRX VM), the virtual machine is created with the same name as the container and starts up when a container starts. It shuts down and is removed when the container stops. 9 | * Use '--memory' and '--cpus' to make specific configurations to the CPU and memory that is available to the container. 10 | * A container running in a virtual machine shares the memory with its hosting virtual machine. (e.g. Within a virtual machine with 1024MB memory, max memory available for the container will be 512MB, and rest of the memory are reserved for the operating system.) 11 | * Use 'vctl system config' to manage the default settings of the virtual machine hosting container. (e.g. vctl system config --vm-mem 2g) 12 | * If no COMMAND is provided, the default command from the image will be executed. 13 | * When '--keepVM' is used, use 'vmrun stop VMX' to manually stop the host virtual machine before using the container again. 14 | 15 | ``` 16 | vctl run [OPTIONS] IMAGE [COMMAND] [ARGUMENTS...] 17 | ``` 18 | 19 | ### Examples 20 | 21 | ``` 22 | # To run a new container using 'myImage' image. 23 | vctl run myImage 24 | 25 | # To set environment variables "FOO=BAR" when running a new container using 'myImage' image. 26 | vctl run --env="FOO=BAR" myImage 27 | 28 | # To set 4 CPU cores limit and 2GB memory limit for a new container using 'myImage' image. (In this case the virtual machine hosting the container will be configured with 4 CPU cores and 2560MB memory.) 29 | vctl run -c 4 -m 2g myImage 30 | 31 | # To run a new container in background. (detached from current terminal) 32 | vctl run --detach myImage 33 | 34 | # To assign name 'myContainer' to the new container to run. 35 | vctl run --name myContainer myImage 36 | 37 | # To keep the host virtual machine running after container stops for potential debug and troubleshooting needs. 38 | vctl run --keepVM myImage 39 | 40 | # To mount folder ~/Documents/toolchain on host to the new container using 'myImage' image. 41 | vctl run --volume ~/Documents/toolchain:/toolchain myImage 42 | ``` 43 | 44 | ### Options 45 | 46 | ``` 47 | -c, --cpus int Number of CPU cores (default 2) 48 | -d, --detach Run the container in background 49 | --entrypoint string Override the default entrypoint of the container image 50 | -e, --env strings Environment variables to set in the container 51 | -h, --help Help for run 52 | --hostname string Host name of the container 53 | -i, --interactive Keep STDIN open even if not attached 54 | --keepVM [EXPERIMENTAL] Keep the host virtual machine running after container stops 55 | -l, --label strings Set additional labels to the container (e.g. foo=bar) 56 | -m, --memory string Limit on memory (MB/GB) available to the container (default "512m") 57 | -n, --name string Assign a name to the container 58 | -r, --privileged Run the container with extended privileges 59 | -p, --publish strings Bind host network ports to container ports 60 | --rm Automatically remove the container when it exits 61 | -t, --tty Allocate a terminal for the container 62 | -v, --volume strings Bind host folders to container folders 63 | -w, --workdir string Working directory of the new process 64 | ``` 65 | 66 | ### SEE ALSO 67 | 68 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 69 | 70 | ###### Auto generated by spf13/cobra on 14-Sep-2020 71 | -------------------------------------------------------------------------------- /man/vctl_start.md: -------------------------------------------------------------------------------- 1 | ## vctl start 2 | 3 | Start an existing container. 4 | 5 | ### Synopsis 6 | 7 | Start a created or stopped container. 8 | * Every container runs in a separate virtual machine, a virtual machine is created with the same name as the container and starts up when a container starts. It shuts down and is removed when the container stops. 9 | * Use '--memory' and '--cpus' to make specific configurations to the CPU and memory available to the container. 10 | * A container running in a virtual machine shares the memory with the operating system. (e.g. Within a virtual machine with 1024MB memory, max memory available for the container will be 512MB, and rest of the memory are reserved for the operating system.) 11 | * Use 'vctl system config' to manage the default settings of the virtual machine hosting container. (e.g. vctl system config --vm-mem 2g) 12 | * When '--keepVM' is used, use 'vmrun stop VMX' to manually stop the host virtual machine before using the container again. 13 | 14 | ``` 15 | vctl start [OPTIONS] CONTAINER 16 | ``` 17 | 18 | ### Examples 19 | 20 | ``` 21 | # To set 4 CPU cores limit and 2GB memory limit for myContainer. (In this case the virtual machine hosting the container will be configured with 4 CPU cores and 2560MB memory.) 22 | vctl start -c 4 -m 2g myContainer 23 | ``` 24 | 25 | ### Options 26 | 27 | ``` 28 | -c, --cpus int Number of CPU cores (default 2) 29 | -d, --detach Run the container in background 30 | -h, --help Help for start 31 | --keepVM [EXPERIMENTAL] Keep the host virtual machine running after container stops 32 | -m, --memory string Limit on memory (MB/GB) available to the container (default "512m") 33 | ``` 34 | 35 | ### SEE ALSO 36 | 37 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 38 | 39 | ###### Auto generated by spf13/cobra on 14-Sep-2020 40 | -------------------------------------------------------------------------------- /man/vctl_stop.md: -------------------------------------------------------------------------------- 1 | ## vctl stop 2 | 3 | Stop a container. 4 | 5 | ### Synopsis 6 | 7 | Stop a running container. 8 | 9 | ``` 10 | vctl stop [OPTIONS] CONTAINER 11 | ``` 12 | 13 | ### Options 14 | 15 | ``` 16 | -h, --help Help for stop 17 | ``` 18 | 19 | ### SEE ALSO 20 | 21 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 22 | 23 | ###### Auto generated by spf13/cobra on 14-Sep-2020 24 | -------------------------------------------------------------------------------- /man/vctl_system.md: -------------------------------------------------------------------------------- 1 | ## vctl system 2 | 3 | Manage the container engine. 4 | 5 | ### Synopsis 6 | 7 | Manage the container engine and the system environment. 8 | 9 | ### Options 10 | 11 | ``` 12 | -h, --help Help for system 13 | ``` 14 | 15 | ### SEE ALSO 16 | 17 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 18 | * [vctl system config](vctl_system_config.md) - Config and initialize the system environment for the container engine. 19 | * [vctl system info](vctl_system_info.md) - Display the container engine information. 20 | * [vctl system start](vctl_system_start.md) - Start the container engine. 21 | * [vctl system stop](vctl_system_stop.md) - Stop the container engine. 22 | 23 | ###### Auto generated by spf13/cobra on 14-Sep-2020 24 | -------------------------------------------------------------------------------- /man/vctl_system_config.md: -------------------------------------------------------------------------------- 1 | ## vctl system config 2 | 3 | Config and initialize the system environment for the container engine. 4 | 5 | ### Synopsis 6 | 7 | Initialize the system environment using default configurations or using the specified configurations. 8 | * Every container runs in a separate virtual machine (CRX VM). The virtual machine is created with the same name as the container and starts up when a container starts. It shuts down and is removed when the container stops. 9 | * A container running in a virtual machine shares the memory with the operating system. (e.g. Within a virtual machine with 1024MB memory, max memory available for the container will be 512MB, and rest of the memory are reserved for the operating system.) 10 | * Use '--vm-cpus' and '--vm-mem' to configure the default CPU & memory values of the virtual machine, the changes will be applied globally to all new virtual machines. 11 | * All local container images and containers will be deleted and the system environment will be initialized if '--mount-name' is used and modified. 12 | 13 | ``` 14 | vctl system config [OPTIONS] 15 | ``` 16 | 17 | ### Examples 18 | 19 | ``` 20 | # To configure the virtual machine that hosts container with 4 CPU cores and 2GB memory by default. (Memory size could also be provided as “2048m”.) 21 | vctl system config --vm-cpus 4 --vm-mem 2g 22 | ``` 23 | 24 | ### Options 25 | 26 | ``` 27 | --cache-location string Specify the cache file location (default "/Users/xiaodongy/.vctl") 28 | -h, --help Help for config 29 | --k8s-cpus int CPU cores of base virtual machine that hosts Kubernetes node (default 2) 30 | --k8s-mem string Memory size (MB/GB) for virtual machine that hosts Kubernetes node (default "2g") 31 | --mount-name string Mount name for container storage (default "Fusion Container Storage") 32 | -s, --storage string Container storage size (default "128g") 33 | -c, --vm-cpus int CPU cores of base virtual machine that hosts container (default 2) 34 | -m, --vm-mem string Memory size (MB/GB) for virtual machine that hosts container (default "1g") 35 | ``` 36 | 37 | ### SEE ALSO 38 | 39 | * [vctl system](vctl_system.md) - Manage the container engine. 40 | 41 | ###### Auto generated by spf13/cobra on 14-Sep-2020 42 | -------------------------------------------------------------------------------- /man/vctl_system_info.md: -------------------------------------------------------------------------------- 1 | ## vctl system info 2 | 3 | Display the container engine information. 4 | 5 | ### Synopsis 6 | 7 | Print detailed information of the container engine. 8 | 9 | ``` 10 | vctl system info [OPTIONS] 11 | ``` 12 | 13 | ### Options 14 | 15 | ``` 16 | -h, --help Help for info 17 | ``` 18 | 19 | ### SEE ALSO 20 | 21 | * [vctl system](vctl_system.md) - Manage the container engine. 22 | 23 | ###### Auto generated by spf13/cobra on 14-Sep-2020 24 | -------------------------------------------------------------------------------- /man/vctl_system_start.md: -------------------------------------------------------------------------------- 1 | ## vctl system start 2 | 3 | Start the container engine. 4 | 5 | ### Synopsis 6 | 7 | Initialize host OS environment for the container engine using default configurations, then start container engine. 8 | 9 | ``` 10 | vctl system start [OPTIONS] 11 | ``` 12 | 13 | ### Examples 14 | 15 | ``` 16 | # To set the log level to debug upon the start of the container engine. 17 | vctl system start -l debug 18 | ``` 19 | 20 | ### Options 21 | 22 | ``` 23 | -c, --compact Compact container storage upon start 24 | -h, --help Help for start 25 | -l, --log-level string Log level for container engine (trace|debug|info|warn|error|fatal|panic) (default "info") 26 | --log-location string Log location for container engine (default "/Users/xiaodongy/.vctl/containerd.log") 27 | ``` 28 | 29 | ### SEE ALSO 30 | 31 | * [vctl system](vctl_system.md) - Manage the container engine. 32 | 33 | ###### Auto generated by spf13/cobra on 14-Sep-2020 34 | -------------------------------------------------------------------------------- /man/vctl_system_stop.md: -------------------------------------------------------------------------------- 1 | ## vctl system stop 2 | 3 | Stop the container engine. 4 | 5 | ### Synopsis 6 | 7 | Terminate the container engine services. 8 | 9 | ``` 10 | vctl system stop [OPTIONS] 11 | ``` 12 | 13 | ### Options 14 | 15 | ``` 16 | -c, --compact Compact container storage upon stop 17 | -f, --force Force quit the container engine and terminate backend virtual machines 18 | -h, --help Help for stop 19 | ``` 20 | 21 | ### SEE ALSO 22 | 23 | * [vctl system](vctl_system.md) - Manage the container engine. 24 | 25 | ###### Auto generated by spf13/cobra on 14-Sep-2020 26 | -------------------------------------------------------------------------------- /man/vctl_tag.md: -------------------------------------------------------------------------------- 1 | ## vctl tag 2 | 3 | Tag container images. 4 | 5 | ### Synopsis 6 | 7 | Create an image alias with the name of the TARGET_IMAGE. 8 | 9 | ``` 10 | vctl tag [OPTIONS] SOURCE_IMAGE TARGET_IMAGE [TARGET_IMAGE...] 11 | ``` 12 | 13 | ### Options 14 | 15 | ``` 16 | -f, --force Replace an existing image if the TARGET_IMAGE name has been taken 17 | -h, --help Help for tag 18 | ``` 19 | 20 | ### SEE ALSO 21 | 22 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 23 | 24 | ###### Auto generated by spf13/cobra on 14-Sep-2020 25 | -------------------------------------------------------------------------------- /man/vctl_version.md: -------------------------------------------------------------------------------- 1 | ## vctl version 2 | 3 | Print the version of vctl. 4 | 5 | ### Synopsis 6 | 7 | Show the version information of vctl. 8 | 9 | ``` 10 | vctl version [OPTIONS] 11 | ``` 12 | 13 | ### Options 14 | 15 | ``` 16 | -h, --help Help for version 17 | ``` 18 | 19 | ### SEE ALSO 20 | 21 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 22 | 23 | ###### Auto generated by spf13/cobra on 14-Sep-2020 24 | -------------------------------------------------------------------------------- /man/vctl_volume.md: -------------------------------------------------------------------------------- 1 | ## vctl volume 2 | 3 | Manage volumes. 4 | 5 | ### Synopsis 6 | 7 | Manage volumes, currently only support volume prune. 8 | 9 | ### Options 10 | 11 | ``` 12 | -h, --help Help for volume 13 | ``` 14 | 15 | ### SEE ALSO 16 | 17 | * [vctl](vctl.md) - vctl - A CLI tool for the container engine powered by VMware Fusion 18 | * [vctl volume prune](vctl_volume_prune.md) - Remove all unused local volumes. 19 | 20 | ###### Auto generated by spf13/cobra on 14-Sep-2020 21 | -------------------------------------------------------------------------------- /man/vctl_volume_prune.md: -------------------------------------------------------------------------------- 1 | ## vctl volume prune 2 | 3 | Remove all unused local volumes. 4 | 5 | ### Synopsis 6 | 7 | Remove all unused local volumes. 8 | 9 | ``` 10 | vctl volume prune [flags] 11 | ``` 12 | 13 | ### Options 14 | 15 | ``` 16 | -f, --force Do not prompt for confirmation 17 | -h, --help Help for prune 18 | ``` 19 | 20 | ### SEE ALSO 21 | 22 | * [vctl volume](vctl_volume.md) - Manage volumes. 23 | 24 | ###### Auto generated by spf13/cobra on 14-Sep-2020 25 | --------------------------------------------------------------------------------