Feb 12, 2018
May 3, 2020 (Retired)
Agoda Company Pte Ltd. (agoda-com)
Anton Malinskiy (Malinskiy)
Nikolay Nesterov (nesterov-n)
Source code


Android devices farm with USB and emulated devices support


$ helm install openstf


This project contains a chart that bootstraps an OpenSTF deployment on a Kubernetes cluster using the Helm package manager.


Installing the Chart

To install the chart with the release name my-release:

$ helm install --name my-release openstf

The command deploys OpenSTF on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.

You need to set emulators.imagePrefix and adb.image.repository values to the images of docker-emulator-android and adb-butler you've built in order for the chart to work properly. This can be done either in values.yaml or via the command-line. The full installation will look something like:

$ helm install --name openstf -f openstf/values.yaml \
    --set emulators.imagePrefix=docker-registry/agoda/docker-emulator-android- \
    --set emulators.imageVersion=1.0.0 \
    --set adb.image.repository=docker-registry/agoda/adb-butler \
    --set pullSecret=docker-registry-secret \
    --set ingress.enabled=true \
    --set ingress.hostname=openstf.svc.cluster.local \
    --set ingress.ssl.enabled=true \
    --set ingress.ssl.secret=ssl-secret \
    --set rethinkdb.password=strongpassword \

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release deployment:

$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Nodes configuration

You need to label and taint the usb provider nodes and kvm nodes as following

USB providers:

$ kubectl label nodes node-x.cluster.local
$ kubectl taint nodes node-x.cluster.local

Emulator nodes:

$ kubectl label nodes node-x.cluster.local


The following tables lists the configurable parameters of the openstf chart and their default values.

Parameter Description Default
stf.image.repository OpenSTF container image repository openstf/stf
stf.image.tag OpenSTF container image tag v3.2.0
stf.image.pullPolicy OpenSTF container image pull policy IfNotPresent
stf.api.replicas Desired number of API pods 3 Desired number of app pods 1
stf.auth.replicas Desired number of auth pods 1
stf.processor.replicas Desired number of processor pods 5
stf.reaper.replicas Desired number of reaper pods 1
stf.apkStorage.replicas Desired number of apk-storage pods 1
stf.imgStorage.replicas Desired number of image-storage pods 1 Desired number of storage pods 1
stf.triproxyDev.replicas Desired number of triproxy-dev pods 1
stf.triproxyApp.replicas Desired number of triproxy-app pods 1
stf.websocket.replicas Desired number of websocket pods 1
nginx.image.repository nginx container image repository nginx
nginx.image.tag nginx container image repository tag 1.13.8-alpine
nginx.image.pullPolicy nginx container image pullPolicy IfNotPresent
nginx.replicas Desired number of nginx pods 1
adb.image.repository adb-butler container image repository agoda/adb-butler
adb.image.tag adb-butler container image repository tag latest
adb.image.pullPolicy adb-butler container image pullPolicy Always
db.url URL of RethinkDB rethinkdb-rethinkdb-proxy.openstf
db.port TCP port of RethinkDB 28015
db.password RethinkDB password rethinkdb
dns.resolver Address of DNS server kube-dns.kube-system
pullSecret Pull secret for pulling all the images ""
ingress.enabled Enable ingress controller resource false
ingress.annotations Custom annotations on ingress resource nginx
ingress.hostname Hostname to your OpenSTF installation openstf.local
ingress.ssl.enabled Utilize TLS backend in ingress false
ingress.ssl.secret TLS Secret (certificates) openstf.local-tls-secret
emulators.imagePrefix Prefix of docker android container image agoda/docker-emulator-android-
emulators.imageVersion Docker android container image tag 25
emulators.pullPolicy Docker android container image pull policy IfNotPresent
emulator.types Types of docker android emulators to spawn see below for more info
telegraf.image.repository telegraf container image repository telegraf
telegraf.image.tag telegraf container image repository tag 1.5-alpine
telegraf.image.pullPolicy telegraf container image pullPolicy IfNotPresent
telegraf.config.outputs.prometheus.enabled provide prometheus metrics on provider pods true

Tip: You can use the default values.yaml

Pod resources

All the pods have sane default resources set. To customize check the values.yaml


In order to create emulators you need to provide configuration inside emulators.types. For example you want the to name the batch of devices tablet7i, add ci/uiTest/tablet/7inch note to all these devices in OpenSTF and change the config.ini variable for emulator. You also want 3 instances of such config with API version 26 and 3 instances with API version 19.

- name: tablet7i
  note: ci/uiTest/tablet/7inch
  args: ";hw.lcd.density=160;hw.lcd.height=600;hw.lcd.width=1024; WSVGA (Tablet);avd.ini.displayname=7  WSVGA (Tablet) API 23;"
  - version: 26
    count: 3
  - version: 19
    count: 3

By default you'll have phones with API versions 17 to 26 and 7' + 10' tablets with API version 25.


android-farm is open source and available under the Apache License, Version 2.0.

OpenSTF is open source and available under the Apache License, Version 2.0

Android SDK components are available under the Android Software Development Kit License

Related projects

The emulators are spawned using the docker-emulator-android container image

Default adb side container image with self-healing and metrics is adb-butler

Connecting to OpenSTF devices with filtering support and reconnect logic is done using stf-client

fork is an instrumentation runner with support for reconnecting to adb devices on-the-go and more

example of ci agent container