Skip to content

Commit

Permalink
2.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Nathan Pierce committed Nov 24, 2020
1 parent 12d9503 commit bfd2344
Show file tree
Hide file tree
Showing 79 changed files with 648 additions and 633 deletions.
Expand Up @@ -177,7 +177,7 @@ Edit the `/usr/local/bin/anka-controllerd` and add the following onto the end of
--enable-registry-authorization \
--skip-tls-verification \
--client-cert $CERT_FOLDER/anka-controller-crt.pem \
--client-key $CERT_FOLDER/anka-controller-key.pem
--client-cert-key $CERT_FOLDER/anka-controller-key.pem
```

### Linux/Docker Controller & Registry package
Expand Down Expand Up @@ -238,7 +238,7 @@ Copy both the Node certificates (node-$NODE_NAME-crt.pem, node-$NODE_NAME-key.pe
Then, use the `ankacluster` command to connect it to the Controller in the following manner:

```shell
sudo ankacluster join https://$CONTROLLER_ADDRESS --cert /Users/$USER_WHERE_CERTS_ARE/node-$NODE_NAME-crt.pem --cert-key /Users/$USER_WHERE_CERTS_ARE/node-$NODE_NAME-key.pem --cacert /Users/$USER_WHERE_CERTS_ARE/anka-ca-crt.pem
sudo ankacluster join https://$CONTROLLER_ADDRESS --skip-tls-verification --cert /Users/$USER_WHERE_CERTS_ARE/node-$NODE_NAME-crt.pem --cert-key /Users/$USER_WHERE_CERTS_ARE/node-$NODE_NAME-key.pem --cacert /Users/$USER_WHERE_CERTS_ARE/anka-ca-crt.pem
You should see output similar to the following:
Testing connection to Controller...: OK
Testing connection to registry….: OK
Expand Down
17 changes: 5 additions & 12 deletions content/en/docs/Anka Virtualization/command-reference.md
Expand Up @@ -8,7 +8,6 @@ description: >
---

{{< include file="./shared/content/en/docs/Anka Virtualization/partials/_index.md" >}}

## Attach
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/attach/_index.md" >}}
## Clone
Expand All @@ -20,10 +19,8 @@ description: >
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/cp/_example.md" >}}
## Create
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/create/_index.md" >}}
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/create/_extra.md" >}}
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/create/_example.md" >}}

> [Advanced usage guide for `anka create`](({{< relref "docs/Getting Started/creating-your-first-vm.md" >}}))
## Delete
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/delete/_index.md" >}}
## Describe
Expand All @@ -40,9 +37,6 @@ description: >
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/license/remove/_index.md" >}}
### license show
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/license/show/_index.md" >}}

> To see current core consumption information for your license, use `anka license show <licensekey>`
### license validate
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/license/validate/_index.md" >}}
## List
Expand All @@ -59,8 +53,7 @@ description: >
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/modify/add/optical-drive/_index.md" >}}
#### modify {vmNameOrUUID} add port-forwarding
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/modify/add/port-forwarding/_index.md" >}}
{{< include file="shared/content/en/docs/Anka Virtualization/partials/modify/add/port-forwarding/_example.md" >}}

{{< include file="./shared/content/en/docs/Anka Virtualization/partials/modify/add/port-forwarding/_example.md" >}}
#### modify {vmNameOrUUID} add usb-device
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/modify/add/usb-device/_index.md" >}}
### modify {vmNameOrUUID} delete
Expand All @@ -85,20 +78,22 @@ description: >
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/modify/set/cpu/_index.md" >}}
#### modify {vmNameOrUUID} set custom-variable
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/modify/set/custom-variable/_index.md" >}}
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/modify/set/custom-variable/_extra.md" >}}
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/modify/set/custom-variable/_example.md" >}}
#### modify {vmNameOrUUID} set description
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/modify/set/description/_index.md" >}}
#### modify {vmNameOrUUID} set display
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/modify/set/display/_index.md" >}}
#### modify {vmNameOrUUID} set hard-drive
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/modify/set/hard-drive/_index.md" >}}
> It's currently impossible to downsize a VM's hard-drive. We suggest creating your initial VM Template with a smaller amount of available disk and then increase in subsequent Tags.
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/modify/set/hard-drive/_extra.md" >}}
#### modify {vmNameOrUUID} set name
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/modify/set/name/_index.md" >}}
#### modify {vmNameOrUUID} set nested
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/modify/set/nested/_index.md" >}}
#### modify {vmNameOrUUID} set network-card
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/modify/set/network-card/_index.md" >}}
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/modify/set/network-card/_extra.md" >}}
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/modify/set/network-card/_example.md" >}}
#### modify {vmNameOrUUID} set policy
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/modify/set/policy/_index.md" >}}
Expand Down Expand Up @@ -138,8 +133,6 @@ description: >
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/show/_index.md" >}}
## Start
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/start/_index.md" >}}
### Install Addons
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/start/install-addons.md" >}}
## Stop
{{< include file="./shared/content/en/docs/Anka Virtualization/partials/stop/_index.md" >}}
## Suspend
Expand Down
@@ -1,5 +1,5 @@
![terminal installation](/images/anka-virtualization/terminal-installation.png)
```shell
curl -L -o AnkaVirtualization.pkg https://veertu.com/downloads/anka-virtualization-beta
curl -L -o AnkaVirtualization.pkg https://veertu.com/downloads/anka-virtualization-latest
sudo installer -pkg AnkaVirtualization.pkg -tgt /
```
4 changes: 2 additions & 2 deletions content/en/docs/Anka Virtualization/partials/attach/_index.md
Expand Up @@ -2,8 +2,8 @@
> sudo anka attach --help
Usage: anka attach [OPTIONS] VMID [DEVID]...

Attach USB device(s) to running VM
Attach USB device(s) to a running VM

Options:
--help Show this message and exit.
--help Display usage information
```
8 changes: 4 additions & 4 deletions content/en/docs/Anka Virtualization/partials/clone/_index.md
@@ -1,10 +1,10 @@
```shell
> sudo anka clone --help
Usage: anka clone [OPTIONS] VM_ID NEW_VM_NAME
Usage: anka clone [OPTIONS] VM_ID [NEW_VM_NAME]...

Clones a VM
Clone a suspended or stopped VM

Options:
-c, --copy Create independent copy instead of clone
--help Show this message and exit.
-c, --copy Create an independent copy (disables caching and consumes more disk space)
--help Display usage information
```
10 changes: 5 additions & 5 deletions content/en/docs/Anka Virtualization/partials/config/_index.md
Expand Up @@ -2,11 +2,11 @@
> sudo anka config --help
Usage: anka config [OPTIONS] [PARAM]...

Manage Anka configuration
Manage the CLI configuration

Options:
-l, --list List value parameter(s)
-r, --reset Reset value of parameter(s)
-s, --sorted / -S, --unsorted Sort the output in alphabetical orders
--help Show this message and exit.
-l, --list List parameter(s)
-r, --reset Reset parameter(s) back to default
-s, --sorted / -S, --unsorted Sort the output in alphabetical order
--help Display usage information
```
6 changes: 3 additions & 3 deletions content/en/docs/Anka Virtualization/partials/cp/_index.md
@@ -1,5 +1,5 @@
```bash
anka cp --help
```shell
> sudo anka cp --help
Usage: anka cp [OPTIONS] [SRC]... DST

Copy files in and out of the VM and host
Expand All @@ -14,4 +14,4 @@ Options:
-p preserve the source file attributes
-a same as -pPR options
--help Display usage information
```
```
22 changes: 1 addition & 21 deletions content/en/docs/Anka Virtualization/partials/create/_example.md
@@ -1,24 +1,4 @@
```shell
sudo anka create --ram-size 8G --cpu-count 4 --disk-size 80G \
--app /Applications/Install\ macOS\ Catalina.app 10.15.6
```

> If you leave out `--ram-size` and `--cpu-count`, Anka will choose for you based on your total CPU and RAM. It will try to halve the total CPU and RAM values, but has a min of 2CPU/4GB and a max of 8CPU/8GB.
> We recommend naming your initial VM after the version of macOS
> **Be aware of the user you're executing Anka CLI commands as.** If you create VMs as root, they won't be available (when running `anka list`) to other users on the system and vice versa
> By default `anka create` creates a VM Template with the username `anka` and password `admin`. Environment variable are available to change these: `ANKA_DEFAULT_USER` and `ANKA_DEFAULT_PASSWD` (be sure to use sudo -E when issuing the create command)
> Catalina VMs require > 4G of RAM and a > 80G disk size
> The VM creation should take around 30 minutes
> **Anka Develop licenses** default your VM in a stopped state (the only available state)
> **Anka Build licenses** default your VM in a suspended state
> **Catalina and lower** VMs are created with SIP/Kext Consent disabled by default. It's strongly advised to keep these settings for optimal Anka performance. If you need to re-enable SIP/Kext Consent, then use this command `anka modify {vmNameOrUUID} set custom-variable sys.csr-active-config 0`
> **Big Sur and higher** VMs are created with SIP/Kext Consent enabled by default.
```
17 changes: 17 additions & 0 deletions content/en/docs/Anka Virtualization/partials/create/_extra.md
@@ -0,0 +1,17 @@
> If you leave out `--ram-size` and `--cpu-count`, Anka will choose for you based on your total CPU and RAM. It will try to halve the total CPU and RAM values, but has a min of 2CPU/4GB and a max of 8CPU/8GB
> We recommend naming your initial VM after the version of macOS
> **Be aware of the user you're executing Anka CLI commands as.** If you create VMs as root, they won't be available (when running `anka list`) to other users on the system and vice versa
> By default `anka create` creates a VM Template with the username `anka` and password `admin`. Environment variable are available to change these: `ANKA_DEFAULT_USER` and `ANKA_DEFAULT_PASSWD` (be sure to use `sudo -E` when issuing the create command)
> The VM creation should take around 30 minutes
> **Anka Develop licenses** default your VM in a stopped state (the only available state)
> **Anka Build licenses** default your VM in a suspended state
> **Catalina and lower** VMs are created with SIP/Kext Consent disabled by default. It's strongly advised to keep these settings for optimal Anka performance. If you need to re-enable SIP/Kext Consent, then use this command `anka modify {vmNameOrUUID} set custom-variable sys.csr-active-config 0`
> **Big Sur and higher** VMs are created with SIP/Kext Consent enabled by default
16 changes: 8 additions & 8 deletions content/en/docs/Anka Virtualization/partials/create/_index.md
Expand Up @@ -5,13 +5,13 @@ Usage: anka create [OPTIONS] VMNAME
Creates a VM

Options:
-m, --ram-size TEXT ram size in G [default: 4G]
-c, --cpu-count INTEGER the number of cpu cores [default: 2]
-d, --disk-size TEXT sets the disk size when creating a new disk, G/M suffix needed [default: 80G]
-a, --app PATH Path to Install macOS Application (downloadable from AppStore)
-p, --pkg PATH Additional package to be installed
-s, --postinstall PATH Postinstall scripts (to run with root credentials at first boot)
-P, --profile PATH Install configuration profile(s) alongside macOS installation
-m, --ram-size TEXT Set the RAM size (including 'G' or 'M' on the end)
-c, --cpu-count INTEGER Set the number of CPU cores
-d, --disk-size TEXT Set the disk size when creating a new disk (including 'G' or 'M' on the end)
-a, --app PATH Path to the macOS installer .app
-p, --pkg PATH Include additional packages to be installed
-s, --postinstall PATH Include the script to run with root credentials on initial boot
-P, --profile PATH Include a configuration profile(s) to install alongside the macOS installation
--interactive Perform default interactive installation instead of the automated one
--help Show this message and exit.
--help Display usage information
```
4 changes: 2 additions & 2 deletions content/en/docs/Anka Virtualization/partials/delete/_index.md
Expand Up @@ -2,10 +2,10 @@
> sudo anka delete --help
Usage: anka delete [OPTIONS] [VMID]...

Deletes a VM(s)
Delete a VM(s)

Options:
--yes Avoid asking of confirmation
-a, --all Delete all vms in library
--help Show this message and exit.
--help Display usage information
```
Expand Up @@ -2,8 +2,8 @@
> sudo anka describe --help
Usage: anka describe [OPTIONS] VM_ID

Shows VM configuration
Show a VM's configuration
Options:
--help Show this message and exit.
--help Display usage information
```
6 changes: 3 additions & 3 deletions content/en/docs/Anka Virtualization/partials/detach/_index.md
Expand Up @@ -2,9 +2,9 @@
> sudo anka detach --help
Usage: anka detach [OPTIONS] VMID [DEVID]...

Detach USB device(s) from the VM
Detach USB device(s) from a VM

Options:
-a, --all detach all devices from the vm
--help Show this message and exit.
-a, --all Detach all devices from the vm
--help Display usage information
```
14 changes: 7 additions & 7 deletions content/en/docs/Anka Virtualization/partials/license/_index.md
Expand Up @@ -2,15 +2,15 @@
> sudo anka license --help
Usage: anka license [OPTIONS] COMMAND [ARGS]...

Licensing commands
Control Licensing

Options:
--help Show this message and exit.
--help Display usage information

Commands:
accept-eula accept EULA (root privileges)
activate activate license key (root privileges)
remove removes the current license (root privileges)
show show license information
validate validates the current license
accept-eula Accept EULA (requires root privileges)
activate Activate license key (requires root...
remove Remove the current license (requires root...
show Show license information
validate Validate the current license
```
Expand Up @@ -2,8 +2,8 @@
> sudo anka license accept-eula --help
Usage: anka license accept-eula [OPTIONS]

accept EULA (root privileges)
Accept EULA (requires root privileges)

Options:
--help Show this message and exit.
--help Display usage information
```
Expand Up @@ -2,10 +2,10 @@
> sudo anka license activate --help
Usage: anka license activate [OPTIONS] KEY

activate license key (root privileges)
Activate license key (requires root privileges)

Options:
-f, --force silently override current license
--cid TEXT provide CustomerID
--help Show this message and exit.
-f, --force Silently override the current license
--cid TEXT Submit the CustomerID
--help Display usage information
```
Expand Up @@ -2,8 +2,8 @@
> sudo anka license remove --help
Usage: anka license remove [OPTIONS]

removes the current license (root privileges)
Remove the current license (requires root privileges)

Options:
--help Show this message and exit.
--help Display usage information
```
@@ -0,0 +1 @@
> To see current core consumption information for your license, use `anka license show <licensekey>`
Expand Up @@ -2,9 +2,9 @@
> sudo anka license show --help
Usage: anka license show [OPTIONS]

show license information
Show license information

Options:
-k, --key TEXT get key information
--help Show this message and exit.
-k, --key TEXT Get key information
--help Display usage information
```
Expand Up @@ -2,8 +2,8 @@
> sudo anka license validate --help
Usage: anka license validate [OPTIONS]

validates the current license
Validate the current license

Options:
--help Show this message and exit.
--help Display usage information
```
10 changes: 5 additions & 5 deletions content/en/docs/Anka Virtualization/partials/list/_index.md
Expand Up @@ -2,12 +2,12 @@
> sudo anka list --help
Usage: anka list [OPTIONS] [VMID]...

List VM library contents
List the current user's VM Template library
Options:
-r, --running show only running vms
-s, --stopped show only stopped vms
-f, --field TEXT configure fields for each VM to be shown. Supported fields: name, version, uuid, creation_date,
-r, --running Show only running vms
-s, --stopped Show only stopped vms
-f, --field TEXT Change the fields displayed for the VM. Supported fields: name, version, uuid, creation_date,
status, stop_date, description, policy, cpu_cores, cpu_frequency, cpu_htt, ram, display.
--help Show this message and exit.
--help Display usage information
```
4 changes: 2 additions & 2 deletions content/en/docs/Anka Virtualization/partials/modify/_index.md
Expand Up @@ -2,10 +2,10 @@
> sudo anka modify --help
Usage: anka modify [OPTIONS] VM_ID COMMAND [ARGS]...

Modifies a VM settings
Modify a VM's configuration
Options:
--help Show this message and exit.
--help Display usage information
Commands:
add
Expand Down
@@ -1,9 +1,9 @@
```shell
> sudo anka modify 10.15.4 add --help
> sudo anka modify 11.0.1 add --help
Usage: anka modify add [OPTIONS] COMMAND [ARGS]...

Options:
--help Show this message and exit.
--help Display usage information

Commands:
hard-drive
Expand Down

0 comments on commit bfd2344

Please sign in to comment.