aboutsummaryrefslogtreecommitdiff
path: root/helm/README.md
diff options
context:
space:
mode:
authorpeter <[email protected]>2021-01-21 19:48:05 -0800
committerpeter <[email protected]>2021-01-21 19:48:05 -0800
commit5561b08e6ab58209cb1a5febd57c355e01530f67 (patch)
treecd8f814d2db614e06ee19f4e81998668755e9fc4 /helm/README.md
parentupdate to reflect more latest changes (diff)
downloaddocker-osx-5561b08e6ab58209cb1a5febd57c355e01530f67.tar.xz
docker-osx-5561b08e6ab58209cb1a5febd57c355e01530f67.zip
add gpu passthrough support as well as dynamic OpenCore regeneration
Diffstat (limited to 'helm/README.md')
-rw-r--r--helm/README.md19
1 files changed, 15 insertions, 4 deletions
diff --git a/helm/README.md b/helm/README.md
index 28fc026..5728202 100644
--- a/helm/README.md
+++ b/helm/README.md
@@ -17,15 +17,16 @@ This installs `docker-osx` in Kubernetes.
1) Kubernetes resource requests/limits
1) Defining version of macOS to install
1) Defining install partition size
-
-### What doesn't/isn't defined
1) Defining a different version of macOS
1) Additional QEMU parameters
1) GPU support
+### What doesn't
+1) Simultaneous VNC + GPU IOMMU (this is a limitation of QEMU :( unfortunately)
+
## Requirements
-*) Install [host machine requirements](https://github.com/cephasara/Docker-OSX#requirements-kvm-on-the-host)
+*) Install [host machine requirements](#INSTALL-QEMU-AND-GPU-IOMMU.md)
*) Ensure you are running QEMU 5.X
*) Kubernetes
*) Helm v2
@@ -39,13 +40,17 @@ This installs `docker-osx` in Kubernetes.
```
docker build \
-t sickcodes/docker-osx-vnc:latest \
- -f vnc-version/Dockerfile .
+ -f helm/Dockerfile .
```
+ _Please ensure you are using the Dockerfile in the `helm` folder_
+
_Do not worry about passing `CPU`, `RAM`, etc as they are handled in `values.yaml` now._
### Installation
+If planning on using a GPU with IOMMU passthrough it is recommended to configure it first and install macOS--otherwise installing may take a very long time depending on your hardware. Please see `qemu.systemInstaller.downloadDelay`, `qemu.systemInstaller.cache`, `qemu.systemDisk.downloadDelay`, and `qemu.systemDisk.cache` for possibly reducing installation time. It has taken me over three hours to install on some occasions with a NVMe secondary disk without GPU passthrough configured..
+
In `values.yaml`..
1) Set a unique password for `vnc.password`.
@@ -56,6 +61,12 @@ In `values.yaml`..
1) Set `service.ip` to reflect an IP address of your choice, or use ingress.
1) Update `extraVolumes.hostPath.path` to something useful for you.
+Optionally..
+1) Install kexts to `kexts.path` and enable.
+1) Adjust `openCore.boot.timeout` if desire for macOS to load automatically.
+1) Add usb devices with `qemu.usb` or `qemu.extraArgs` if desired.
+1) Add more ports for portforwarding services if needed.
+
Afterwards..
1) Launch your VNC viewer of choice and connect to the IP/hostname you defined + the port `8888` with the password specified