aboutsummaryrefslogtreecommitdiff
path: root/helm/README.md
diff options
context:
space:
mode:
authorsickcodes <[email protected]>2021-01-14 08:57:17 +0000
committerGitHub <[email protected]>2021-01-14 08:57:17 +0000
commita9a7863c3cab104081d6b9e87d3a8b4a996ad9ac (patch)
treedd380f79fd2b75e7c76012c5f34bf35294e14b87 /helm/README.md
parentUse IMAGE_PATH as a variable during envsubst for the full path of mac_hdd_ng.img (diff)
parentupdate doc with features (diff)
downloaddocker-osx-a9a7863c3cab104081d6b9e87d3a8b4a996ad9ac.tar.xz
docker-osx-a9a7863c3cab104081d6b9e87d3a8b4a996ad9ac.zip
Merge pull request #124 from cephasara/master
Add helm chart
Diffstat (limited to 'helm/README.md')
-rw-r--r--helm/README.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/helm/README.md b/helm/README.md
new file mode 100644
index 0000000..34fc6a9
--- /dev/null
+++ b/helm/README.md
@@ -0,0 +1,44 @@
+# docker-osx
+
+## Information
+
+This installs `docker-osx` in Kubernetes.
+
+## Features
+
+### What works
+1) Setting cpu/memory options
+1) Setting VNC password
+1) Persistance
+1) Setting SMBIOS
+1) QEMU/virtio cpu changes
+1) Toggling Audio
+1) Additional port forwarding
+1) Kubernetes resource requests/limits
+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
+
+## Requirements
+
+*) Install [host machine requirements](https://github.com/cephasara/Docker-OSX#requirements-kvm-on-the-host)
+ *) Ensure you are running QEMU 5.X
+*) Kubernetes
+*) Helm
+*) `sickcodes/docker-osx-vnc` Docker image
+
+### Build `sickcodes/docker-osx-vnc`
+
+1) Go back to the root directory
+1) Build docker image
+
+ ```
+ docker build \
+ -t sickcodes/docker-osx-vnc:latest \
+ -f vnc-version/Dockerfile .
+ ```
+
+_Do not worry about passing `CPU`, `RAM`, etc as they are handled in `values.yaml` now._ \ No newline at end of file