Skip to content

Latest commit

 

History

History
85 lines (69 loc) · 3.06 KB

cvdr.md

File metadata and controls

85 lines (69 loc) · 3.06 KB

cvdr

This page describes about cvdr and its usage.

What's cvdr?

cvdr is a CLI binary tool for accessing and managing Cuttlefish instances remotely. It wraps Cloud Orchestrator, to provide user-friendly interface.

Please run cvdr --help for advanced functionalities of cvdr not described below, such as launching Cuttlefish with locally built image.

Download cvdr

Since the Debian package cuttleifsh-cvdremote containing cvdr is not registered in the official Debian repository, we need to enroll JFrog repository with commands below.

sudo apt install wget
wget -qO- https://artifacts.codelinaro.org/artifactory/linaro-372-googlelt-gigabyte-ampere-cuttlefish-installer/gigabyte-ampere-cuttlefish-installer/latest/debian/linaro-glt-gig-archive-bookworm.asc | sudo tee /etc/apt/trusted.gpg.d/linaro-glt-gig-archive-bookworm.asct
echo "deb https://artifacts.codelinaro.org/linaro-372-googlelt-gigabyte-ampere-cuttlefish-installer/gigabyte-ampere-cuttlefish-installer/latest/debian bookworm main" | sudo tee /etc/apt/sources.list.d/linaro-glt-gig-archive-bookworm.list
sudo apt update

Then cuttlefish-cvdremote is available to download via apt install.

sudo apt install cuttlefish-cvdremote
cvdr --help

Configure cvdr

Please check and modify the configuration file(~/.config/cvdr/cvdr.toml). See either build/debian/cuttlefish_cvdremote/host/etc/cvdr.toml or scripts/on-premises/single-server/cvdr.toml as examples of how to write a configuration file.

Use cvdr

Let's assume using the latest Cuttlefish x86_64 image enrolled in ci.android.com.

Please run:

cvdr \
--branch=aosp-main \
--build_target=aosp_cf_x86_64_phone-trunk_staging-userdebug \
create

Then we expect the result like below.

Creating Host........................................ OK
Fetching main bundle artifacts....................... OK
Starting and waiting for boot complete............... OK
Connecting to cvd-1.................................. OK
2e8137432a96f93558c838da5e590ec775a97e5a7bb20e66929d1a59eb337351 (http://localhost:8080/v1/zones/local/hosts/2e8137432a96f93558c838da5e590ec775a97e5a7bb20e66929d1a59eb337351/)
  cvd/1
  Status: Running
  ADB: 127.0.0.1:33975
  Displays: [720 x 1280 ( 320 )]
  Logs: http://localhost:8080/v1/zones/local/hosts/2e8137432a96f93558c838da5e590ec775a97e5a7bb20e66929d1a59eb337351/cvds/1/logs/

If you want to validate, please refer the first provided URL in the output log and check if the page seems like below. Also, you should be able to see the device is enrolled via adb devices. cvdr_cf_creation

Manually build and run cvdr

To build cvdr manually, please run:

git clone https://github.com/google/cloud-android-orchestration.git
cd cloud-android-orchestration # Root directory of git repository
go build ./cmd/cvdr

To run cvdr, please run:

CVDR_USER_CONFIG_PATH=/path/to/cvdr.toml ./cvdr --help