OpenVidu Elastic: Administration#
Warning
While in BETA this section is subject to changes. We are working to simplify the configuration and administration of OpenVidu Elastic.
The OpenVidu installer offers an easy way to deploy OpenVidu Elastic on-premises. However, once the deployment is complete, you may need to perform administrative tasks based on your specific requirements, such as changing passwords, specifying custom configurations, and starting or stopping services.
This section provides details on configuration parameters and common administrative tasks for on-premises OpenVidu Elastic deployments.
Starting, stopping, and restarting OpenVidu#
To start, stop, or restart any Node in your OpenVidu Elastic deployment, you can use the following commands:
Start OpenVidu
Stop OpenVidu
Restart OpenVidu
Checking the status of services#
You can check the status of the OpenVidu services using the following command:
Depending on the node type, you will see different services running.
The services are operating correctly if you see an output similar to the following and there are no restarts from any of the services:
NAME IMAGE COMMAND SERVICE CREATED STATUS
app docker.io/openvidu/openvidu-call "docker-entrypoint.s…" app 12 seconds ago Up 10 seconds
caddy docker.io/openvidu/openvidu-pro-caddy "/bin/caddy run --co…" caddy 12 seconds ago Up 10 seconds
dashboard docker.io/openvidu/openvidu-pro-dashboard "./openvidu-dashboard" dashboard 12 seconds ago Up 10 seconds
grafana docker.io/grafana/grafana "/run.sh" grafana 11 seconds ago Up 8 seconds
loki docker.io/grafana/loki "/usr/bin/loki -conf…" loki 11 seconds ago Up 9 seconds
mimir docker.io/grafana/mimir "/bin/mimir -config.…" mimir 11 seconds ago Up 9 seconds
minio docker.io/bitnami/minio "/opt/bitnami/script…" minio 11 seconds ago Up 9 seconds
mongo docker.io/mongo "docker-entrypoint.s…" mongo 11 seconds ago Up 9 seconds
openvidu-v2compatibility docker.io/openvidu/openvidu-v2compatibility "/bin/server" openvidu-v2compatibility 12 seconds ago Up 10 seconds
operator docker.io/openvidu/openvidu-operator "/bin/operator" operator 12 seconds ago Up 10 seconds
promtail docker.io/grafana/promtail "/usr/bin/promtail -…" promtail 11 seconds ago Up 9 seconds
redis docker.io/redis "docker-entrypoint.s…" redis 12 seconds ago Up 10 seconds
The services are operating correctly if you see an output similar to the following and there are no restarts from any of the services:
NAME IMAGE COMMAND SERVICE CREATED STATUS
egress docker.io/livekit/egress "/entrypoint.sh" egress 53 seconds ago Up 51 seconds
ingress docker.io/livekit/ingress "ingress" ingress 53 seconds ago Up 52 seconds
openvidu docker.io/openvidu/openvidu-server-pro "/livekit-server --c…" openvidu 53 seconds ago Up 52 seconds
prometheus docker.io/prom/prometheus "/bin/prometheus --c…" prometheus 53 seconds ago Up 51 seconds
promtail docker.io/grafana/promtail "/usr/bin/promtail -…" promtail 53 seconds ago Up 52 seconds
Checking logs#
If any of the services are not working as expected, you can check the logs of the services using the following command:
Replace <service-name> with the name of the service you want to check. For example, to check the logs of the OpenVidu Server, use the following command:
To check the logs of all services, use the following command:
You can also review your logs using the Grafana dashboard provided with OpenVidu. To access it, go to https://<your-domain.com>/grafana and use the credentials located in /opt/openvidu/.env to log in. Once inside, navigate to the "Home" section, select "Dashboard", and then click on:
- "OpenVidu > OpenVidu Cluster Nodes Logs": To check the logs of the OpenVidu services organized per node.
- "OpenVidu > OpenVidu Cluster Services Logs": To check the logs of the OpenVidu services organized per service.
Adding Media Nodes#
To add a new Media Node, simply spin up a new VM and run the OpenVidu installer script to integrate it into the existing cluster. Run the installation command on the new Media Node.
Removing Media Nodes Gracefully#
To stop a Media Node gracefully, you need to stop the containers openvidu, ingress, and egress with a SIGINT signal. Here is a simple script that you can use to stop all these containers gracefully:
#!/bin/bash
# Stop OpenVidu, Ingress, and Egress containers gracefully (1)
docker container kill --signal=SIGINT openvidu || true
docker container kill --signal=SIGINT ingress || true
docker container kill --signal=SIGINT egress || true
# Wait for the containers to stop (2)
while [ $(docker inspect -f '{{.State.Running}}' openvidu 2>/dev/null) == "true" ] || \
[ $(docker inspect -f '{{.State.Running}}' ingress 2>/dev/null) == "true" ] || \
[ $(docker inspect -f '{{.State.Running}}' egress 2>/dev/null) == "true" ]; do
echo "Waiting for containers to stop..."
sleep 5
done
- This script stops the OpenVidu, Ingress, and Egress containers gracefully. The
trueat the end of each command is to avoid the script from stopping if the container is not running. - This script waits for the containers to stop before exiting.
When all the containers are stopped, you can then stop the systemd service and remove the VM:
Removing Media Nodes Forcefully#
To remove a Media Node forcefully, without considering the rooms, ingress, and egress processes running in the node, you can simply stop the OpenVidu service in the Media Node and delete the VM.
Changing the configuration#
You can check how to change the configuration in the Changing Configuration section. Also, there are multiple guides in the How to Guides section that can help you with specific configuration changes.
Uninstalling OpenVidu#
To uninstall any OpenVidu Node, just execute the following commands: