MSM Deployments

This repository contains deployment scripts and configurations for the Media Streaming Mesh (MSM) project.

MSM is an open-source framework that enables real-time media applications to be first-class citizens in cloud-native Kubernetes environments.

MSM facilitates real-time audio and video streaming over the Internet using a distributed mesh network, is designed to be resilient to network disruptions, and is capable of delivering high-quality media streams with low latency.

The deployments in this repository are designed to help users quickly set up and run an MSM deployment.

Note that the initial implementation of MSM only supports a single media stream per pod and a single media stream between any two nodes. These limitations will be resolved when we move from the current Golang prototype data-plane to an asynchronous Rust data-plane.

Contents

This repository contains several directories, each of which represents a different deployment scenario:

msm: Contains templates and values for deploying the MSM infrastructure using Helm Charts.

camera: Contains templates and values for deploying Live Camera Feeds on MSM using Helm Charts.

ingress: Containes templates and values for deploying an nginx ingress on MSM using Helm Charts.

rtsp: Contains templates and values for deploying an RTSP Server on MSM using Helm Charts.

Each deployment scenario has its own README file with instructions on how to set up and run the deployment.

Usage

Helm must be installed to use these charts. Please refer to the official documentation to get started. The below command assume a v3 Helm version, although the charts should work with Helm v2 the command options may be different.

helm repo add msm https://charts.mediastreamingmesh.io

You can then see the charts by running:

helm search repo msm

You can install charts using the following command:

helm install <your-name> msm/CHART --namespace <your-namespace> --create-namespace

Tip: List all installed releases using helm list.

To uninstall a chart release:

helm delete my-release --namespace <your-namespace>

Our recommendation is that you deploy the msm helm chart first, as that sets up the base MSM infrastructure. Then deploy the ingress helm chart if you want support for HLS streaming as well as RTSP. Finally deploy the rtsp chart (if you want to use a fake camera feed) or the camera chart (if you have a real RTSP camera).

Contributing

We welcome contributions to this repository. If you would like to contribute, please submit a pull request with your changes.

Before submitting a pull request, please make sure that your changes follow our coding guidelines and that all tests pass.

Show your support

Give a ⭐️ if this project helped you!

License

MSM Deployments is licensed under the Apache License, Version 2.0. See the LICENSE file for more information.

Contact

If you have any questions or comments about MSM Deployments, please email us at [email protected].