From ddc24e5dc5eab07292a073d20e3d238f96d1b930 Mon Sep 17 00:00:00 2001 From: Vishal Banthia Date: Tue, 24 Nov 2015 13:07:11 +0900 Subject: [PATCH] Mention about setup-examples in README and DEPLOYMENT doc --- README.md | 4 ++-- doc/DEPLOYMENT.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 195598e7..23682d7c 100644 --- a/README.md +++ b/README.md @@ -144,7 +144,7 @@ You should now have a working installation for local development. ## Running -STF comprises of several independent processes that must normally be launched separately. In our own setup each one these processes is its own [systemd](http://www.freedesktop.org/wiki/Software/systemd/) unit. See [DEPLOYMENT.md](doc/DEPLOYMENT.md) if you're interested. +STF comprises of several independent processes that must normally be launched separately. In our own setup each one these processes is its own [systemd](http://www.freedesktop.org/wiki/Software/systemd/) unit. See [DEPLOYMENT.md](doc/DEPLOYMENT.md) and [Setup Examples](https://github.com/openstf/setup-examples) if you're interested. For development purposes, however, there's a helper command to quickly launch all required processes along with a mock login implementation. Note that you **must** have RethinkDB running first. @@ -180,7 +180,7 @@ To update your development version, simply pull the repo and run `npm install` a ### Can I deploy STF to actual servers? -Yes, see [DEPLOYMENT.md](doc/DEPLOYMENT.md). +Yes, see [DEPLOYMENT.md](doc/DEPLOYMENT.md) and [Setup Examples](https://github.com/openstf/setup-examples). ### Will I have to change battery packs all the time? diff --git a/doc/DEPLOYMENT.md b/doc/DEPLOYMENT.md index 524c9a15..2c95aee6 100644 --- a/doc/DEPLOYMENT.md +++ b/doc/DEPLOYMENT.md @@ -1,6 +1,6 @@ # Deployment -So you've got STF running via `stf local` and now you'd like to deploy it to real servers. While there are of course various ways to set everything up, this document will focus on a [systemd](http://www.freedesktop.org/wiki/Software/systemd/) + [Docker](https://www.docker.com/) deployment. Even if you've got a different setup, you should be able to use the configuration files as a rough guide. +So you've got STF running via `stf local` and now you'd like to deploy it to real servers. While there are of course various ways to set everything up, this document will focus on a [systemd](http://www.freedesktop.org/wiki/Software/systemd/) + [Docker](https://www.docker.com/) deployment. Even if you've got a different setup, you should be able to use the configuration files as a rough guide. You can also check some [Setup Examples](https://github.com/openstf/setup-examples) which uses [Vagrant](https://www.vagrantup.com/) and [Virtual Box](https://www.virtualbox.org/) to create a virtual setup. But before going there, it is highly recommended that you read this document thoroughly. STF consists of multiple independent processes communicating via [ZeroMQ](http://zeromq.org/) and [Protocol Buffers](https://github.com/google/protobuf). We call each process a "unit" to match systemd terminology.