Skip to content

Commit

Permalink
readme and deployment script
Browse files Browse the repository at this point in the history
  • Loading branch information
davidzhao committed May 2, 2021
1 parent 4c72fb8 commit da31c40
Show file tree
Hide file tree
Showing 4 changed files with 75 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
build/
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@

LiveKit's helm charts are published on S3.

## Installing helm

Add it to your helm repo with:

```shell
helm repo add livekit https://helm.livekit.io
```

Customize values in values-sample.yaml

Then install the chart

```shell
helm install <instance_name> livekit/livekit-server --namespace <namespace> --values values.yaml
```

## For LiveKit Helm developers

Publishing requires helm-s3 plugin

```shell
helm plugin install https://github.com/hypnoglow/helm-s3.git
AWS_REGION=us-east-1 helm repo add livekit s3://livekit-helm

./deploy.sh
```
9 changes: 9 additions & 0 deletions deploy.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#!/bin/sh

set -euxo pipefail

rm -rf build
mkdir -p build
helm package livekit-server --destination build
cd build
AWS_REGION=us-east-1 helm s3 push ./livekit-server*.tgz livekit
36 changes: 36 additions & 0 deletions values-sample.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
replicaCount: 1

livekit:
# port: 7880
log_level: info
rtc:
use_external_ip: true
# default ports used
# udp_port: 7900
# tcp_port: 7901
redis:
address: <your_redis_address>
# db: 0
# username:
# password:
# one or more API key/secret pairs
keys:
myapikey: "myapisecret"

loadBalancer:
# valid values: disable, alb, aws
# in order to use alb, aws-ingress-controller must be installed
# https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html
type: alb
hosts:
- livekit.myhost.com
tls:
# set to enabled if desired. TLS is only supported with ALB today
enabled: true

autoscaling:
# set to true to enable autoscaling. when set, ignores replicaCount
enabled: false
minReplicas: 1
maxReplicas: 5
targetCPUUtilizationPercentage: 60

0 comments on commit da31c40

Please sign in to comment.