Skip to content

Commit

Permalink
Update documentation for downloading docker image from AR
Browse files Browse the repository at this point in the history
  • Loading branch information
0405ysj committed Dec 24, 2024
1 parent ab11291 commit 783ae9a
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 46 deletions.
48 changes: 2 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,49 +45,5 @@ to obtain the script.

## Docker

We also provide the docker image with installed cuttlefish debian packages
inside; including `cuttlefish-base`, `cuttlefish-user`, and
`cuttlefish-orchestration`.
Currently it's available for x86_64 and ARM64 architecture.

### Build docker image manually

Please run below command to build manually.

```bash
cd /path/to/android-cuttlefish
cd docker
./image-builder.sh
```

You can validate if the docker image is successfully built by checking
`cuttlefish-orchestration` in `docker image list` like below.
```
$ docker image list
REPOSITORY TAG IMAGE ID CREATED SIZE
cuttlefish-orchestration latest 0123456789ab 2 minutes ago 690MB
...
```

### Download prebuilt image

Downloading latest image is available on
[Github action history](https://github.com/google/android-cuttlefish/actions/workflows/artifacts.yaml?query=event%3Apush).

After downloading image, please load the image and verify with
`docker image list`.

```bash
docker load --input ${PATH_TO_PREBUILT_DOCKER_IMAGE}
```

Registering the tag of loaded image as `latest` is available with below script.

```bash
docker tag cuttlefish-orchestration:${PREBUILT_DOCKER_IMAGE_TAG} cuttlefish-orchestration:latest
```

### Use docker image with Cloud Orchestrator

Please refer to
[Cloud Orchestrator documentation](https://github.com/google/cloud-android-orchestration/blob/main/docs/cloud_orchestrator.md).
Please read [docker/README.md](docker/README.md) to know how to use docker image
containing Cuttlefish debian packages.
43 changes: 43 additions & 0 deletions docker/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Docker

We provide docker images with installed cuttlefish debian packages inside;
including `cuttlefish-base`, `cuttlefish-user`, and `cuttlefish-orchestration`.
Currently it's available for x86_64 and ARM64 architectures.

## Download docker image

Currently docker image is available to download from Artifact Registry.
Please run command below to download latest version of docker image.

Also, please choose one location among `us`, `europe`, or `asia`.
It's available to download artifacts from any location, but download latency is
different based on your location.

```bash
DOWNLOAD_LOCATION=us # Choose one among us, europe, or asia.
docker pull $DOWNLOAD_LOCATION-docker.pkg.dev/android-cuttlefish-artifacts/cuttlefish-orchestration/cuttlefish-orchestration
```

## Use docker image with Cloud Orchestrator

Please refer to
[Cloud Orchestrator documentation for on-premise server](https://github.com/google/cloud-android-orchestration/blob/main/scripts/on-premises/single-server/README.md).

## Build docker image manually

Please run below command to build manually.

```bash
cd /path/to/android-cuttlefish
cd docker
./image-builder.sh -d
```

You can validate if the docker image is successfully built by checking
`cuttlefish-orchestration` in `docker image list` like below.
```
$ docker image list
REPOSITORY TAG IMAGE ID CREATED SIZE
cuttlefish-orchestration latest 0123456789ab 2 minutes ago 690MB
...
```

0 comments on commit 783ae9a

Please sign in to comment.