Skip to content

Commit f6fcaf0

Browse files
committed
Update documentation
1 parent f059290 commit f6fcaf0

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
## Smartphone Test Farm Setup Examples
22

3-
[Smartphone Test Farm](https://github.com/openstf/stf) is a great tool to create on-premise device farm. And also, it is very easy to get started with it using it's `stf local` feature. But the problem is this feature was developed for debugging purpose. Users are not supposed to use it in production environment. It is okay to use it for a small farm of 10 ~ 15 devices with one host machine. But to scale the service you will have to deploy it on a computer cluster.
3+
[Smartphone Test Farm](https://github.com/openstf/stf) is a great tool to create on-premise device farm. And also, it is very easy to get started with it using it's `stf local` feature. But the problem is, this feature was developed for development purpose. Users are not supposed to use it in production. It is okay to use it for a small farm of 10 ~ 15 devices with one host machine. But to scale you will have to deploy it over a cluster instead.
44

5-
This project will provide various setup examples for STF in production environment. I will be using [Vagrant](https://www.vagrantup.com/) with [VirtualBox](https://www.virtualbox.org/) provider to create virtual cluster for demonstration.
5+
This project will provide various setup examples of STF in production environment. I will be using [Vagrant](https://www.vagrantup.com/) with [VirtualBox](https://www.virtualbox.org/) provider to create virtual cluster for demonstration.
66

77
## Assumptions
88
- This project assumes that you already have read following nicely written documents. In case you haven't read, it is highly recommended to read them before going ahead.
@@ -12,8 +12,9 @@ This project will provide various setup examples for STF in production environme
1212
- *Theoritically this can be done on any OS which supports VirtualBox and Vagrant but they haven't been confirmed yet!*
1313

1414
## Requirements
15-
- [VirtualBox](https://www.virtualbox.org/) >= 5.4.0
16-
- [Vagrant](https://www.vagrantup.com/) >= 1.7.3
15+
- [VirtualBox](https://www.virtualbox.org/) >= 5.1.0
16+
- [VirtualBox Extension Pack](https://www.virtualbox.org/)
17+
- [Vagrant](https://www.vagrantup.com/) >= 1.8.5
1718

1819
## Setup Architecture
1920
Before going any further, I am going to give you a brief idea about what kind of setups are we going to do. Most of the setups will have two major components.
@@ -42,15 +43,15 @@ cd ./db; vagrant up
4243
```
4344

4445
Above command will do following things
45-
- Download **ubuntu/trusty64** image if image is not present (*this may take time depending on internet speed*)
46+
- Download **bento/ubuntu-16.04** image if image is not present (*this may take time depending on internet speed*)
4647
- Launch Ubuntu VM and set its IP to `198.162.50.11`
4748
- Install and run rethinkdb server
4849

4950
You can confirm if rethinkdb is up by visiting rethinkdb [admin console](http://198.162.50.11:8080)
5051

5152
Please have a look at [Vagrantfile](db/Vagrantfile) to have better understanding about what is happening.
5253

53-
**TODO**: Use 2 instances of VM for rethinkdb if somebody complains that this is not a real cluster :P
54+
**TODO**: Use 2 instances of VM for rethinkdb if somebody complains that this is not a real cluster.
5455

5556
## Create STF Cluster
5657

docs/coreos_fleet.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,9 @@
1010
### Add usb filters
1111
In order to access real devices from VMs, it is necessary to create usb filters. Update [Vagrantfile](../coreos/Vagrantfile) for this. Instructions are written in file itself.
1212

13-
1. Connect the android device or devices to your OS X and check if they are properly connected by running `adb devices`
14-
2. Get vendor_id and product_id of devices using `VBoxManage list usbhost` command. It will display something like this
13+
1. Make sure VirtualBox Extension Pack is installed
14+
2. Connect the android device or devices to your OS X and check if they are properly connected by running `adb devices`
15+
3. Get vendor_id and product_id of devices using `VBoxManage list usbhost` command. It will display something like this
1516

1617
```
1718
UUID: e7757772-3030-44a3-ac14-00e53e9e32f8
@@ -27,7 +28,7 @@ In order to access real devices from VMs, it is necessary to create usb filters.
2728
Current State: Busy
2829
```
2930

30-
3. Uncomment the usbfilter line in [Vagrantfile](../coreos/Vagrantfile) and rewrite it like this.
31+
4. Uncomment the usbfilter line in [Vagrantfile](../coreos/Vagrantfile) and rewrite it like this.
3132

3233
From:
3334
```sh

0 commit comments

Comments
 (0)