Rewrite for newest PMS version. Add easy deploy helm chart.

2018-01-07 12:55:34 +00:00
parent 9721a0f210
commit d5d145409a
16 changed files with 712 additions and 0 deletions
@@ -0,0 +1,62 @@
+# kube-plex
+
+kube-plex is a scalable Plex Media Server solution for Kubernetes. It
+distributes transcode jobs by creating pods in a Kubernetes cluster to perform
+transcodes, instead of running transcodes on the Plex Media Server instance
+itself.
+
+## How it works
+
+kube-plex works by replacing the Plex Transcoder program on the main PMS
+instance with our own little shim. This shim intercepts calls to Plex
+Transcoder, and creates Kubernetes pods to perform the work instead. These
+pods use shared persistent volumes to store the results of the transcode (and
+read your media!).
+
+## Prerequisites
+
+* A persistent volume type that supports ReadWriteMany volumes (e.g. NFS,
+Amazon EFS)
+* Your Plex Media Server *must* be configured to allow connections from
+unauthorized users for your pod network, else the transcode job is unable to
+report information back to Plex about the state of the transcode job. At some
+point in the future this may change, but it is a required step in order to make
+transcodes work right now.
+
+## Setup
+
+This guide will go through setting up a Plex Media Server instance on a
+Kubernetes cluster, configured to launch transcode jobs on the same cluster
+in pods created in the same 'plex' namespace.
+
+1) Obtain a Plex Claim Token by visiting [plex.tv/claim](https://plex.tv/claim).
+This will be used to bind your new PMS instance to your own user account
+automatically.
+
+2) Deploy the Helm chart included in this repository:
+
+```bash
+➜  helm install ./charts/kube-plex --name plex \
+    --namespace plex \
+    --set claimToken=[insert claim token here]
+```
+
+This will deploy a scalable Plex Media Server instance.
+
+3) Access the Plex dashboard, either using `kubectl port-forward` or via your
+services LoadBalancer IP address. Set up your Plex server and appropriate media.
+
+4) Visit Settings->Server->Network and add your pod network subnet to the
+`List of IP addresses and networks that are allowed without auth` (near the
+bottom). For example, `10.100.0.0/16` is the subnet that pods in my cluster are
+assigned IPs from.
+
+You should now be able to play media from your PMS instance - pods will be
+created to handle transcodes, and data automatically mounted in appropriately:
+
+```bash
+➜  kubectl get po -n plex
+NAME                              READY     STATUS    RESTARTS   AGE
+plex-kube-plex-75b96cdcb4-skrxr   1/1       Running   0          14m
+pms-elastic-transcoder-7wnqk      1/1       Running   0          8m
+```