Skip to content

README.md

Latest commit

 

History

History
69 lines (57 loc) · 2.83 KB

README.md

File metadata and controls

69 lines (57 loc) · 2.83 KB

Activate cloud orchestrator at on-premise server

This page describes how to run cloud orchestrator at on-premise server, which manages docker instances containing the host orchestrator inside.

Try cloud orchestrator

Currently we're hosting docker images and its configuration files in Artifact Registry. Please execute the commands below if you want to download and run the cloud orchestrator.

sudo docker pull us-docker.pkg.dev/android-cuttlefish-artifacts/cuttlefish-orchestration/cuttlefish-cloud-orchestrator:unstable
wget -O conf.toml https://artifactregistry.googleapis.com/download/v1/projects/android-cuttlefish-artifacts/locations/us/repositories/cloud-orchestrator-config/files/on-premise-single-server:unstable:conf.toml:download?alt=media
sudo docker run -d \
    -p 8080:8080 \
    -e CONFIG_FILE="/conf.toml" \
    -v $PWD/conf.toml:/conf.toml \
    -v /var/run/docker.sock:/var/run/docker.sock \
    -t us-docker.pkg.dev/android-cuttlefish-artifacts/cuttlefish-orchestration/cuttlefish-cloud-orchestrator:unstable

To enable TURN server support for WebRTC peer-to-peer connections, configure your TURN server settings in the conf.toml file before starting the cloud orchestrator. See the example below.

[[WebRTC.IceServers]]
URLs = ["turn:localhost:3478"]
Username = "username"
Credential = "credential"

If there's a firewall which blocks accessing cloud orchestrator with HTTP/HTTPS requests, please try using SOCKS5 proxy. Establishing SOCKS5 proxy by creating SSH dynamic port forwarding is available with following command.

ssh -D ${SOCKS5_PORT} -q -C -N ${USERNAME}@${CLOUD_ORCHESTRATOR_IPv4_ADDRESS}

Use cloud orchestrator by cvdr

The config file for cvdr is located at scripts/on-premises/single-server/cvdr.toml. Please follow the steps at cvdr.md, to get started with cvdr.

Batch creation by cvdr

Unfortunately, we don't support bulk/batch creation on cvdr yet, such as creating Cuttlefish instances across multiple hosts. Please scripts/on-premises/single-server/cvdr_create_multiple_hosts.sh instead for a moment to create multiple identical hosts with running Cuttlefish instances in them.

Manually build and run cloud orchestrator

The config file for cloud orchestrator is at scripts/on-premises/single-server/conf.toml. Please follow the steps at cloud_orchestrator.md, to build and run cloud orchestrator.

Also, you may need to prepare another docker image containing the host orchestrator inside, unlike steps in Try cloud orchestrator. Please follow the docker part of README.md in google/android-cuttlefish github repository, and check if proper docker image exists via docker image list.