From 1117ab95a23a1966609a0c3d8b5d9b4e4c013a45 Mon Sep 17 00:00:00 2001 From: Pengfei Qu Date: Fri, 27 Sep 2019 08:23:45 +0800 Subject: [PATCH] update the REAMDE for VCAC-A depolyment and cmake option --- README.md | 2 ++ deployment/docker-swarm/README.md | 21 ++++++++++++++++++++- doc/cmake.md | 16 ++++++++++++++++ 3 files changed, 38 insertions(+), 1 deletion(-) create mode 100644 doc/cmake.md diff --git a/README.md b/README.md index ff28a5bc..09973827 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,7 @@ See additional information on each service: (3) cmake .. (4) make ``` +See also how to customize the building process with [cmake options](doc/cmake.md). ### Generate DASH/HLS segments @@ -61,6 +62,7 @@ Use the following commands to start/stop services via docker swarm: (1) make start_docker_swarm (2) make stop_docker_swarm ``` +See also how to setup [docker swarm](deployment/docker-swarm/README.md). Use the following commands to start/stop services via docker-compose: ```bash diff --git a/deployment/docker-swarm/README.md b/deployment/docker-swarm/README.md index 0df03e13..20175d9e 100644 --- a/deployment/docker-swarm/README.md +++ b/deployment/docker-swarm/README.md @@ -31,4 +31,23 @@ Finally, start/stop services as follows: ``` make start_docker_swarm make stop_docker_swarm -``` \ No newline at end of file +``` + +### Docker Swam Single Machine Deployment with VCAC-A + +Initialize VCAC-A node setup if you have not: +``` +script/setup-vcac-a.sh +``` + +Update the Image to the VCAC-A node: +``` +script/update-image.sh +``` + +Then start/stop services as follows: +``` +make start_docker_swarm +make stop_docker_swarm +``` + diff --git a/doc/cmake.md b/doc/cmake.md new file mode 100644 index 00000000..66c91250 --- /dev/null +++ b/doc/cmake.md @@ -0,0 +1,16 @@ + +Use the following definitions to customize the building process: +- **PLATFORM**: Specify the target platform. Currently the supported platform is ```Xeon``` and ```VCAC-A```. + +### Examples: + +``` +cd build +cmake -DPLATFORM=Xeon .. +``` + +``` +cd build +cmake -DPLATFORM=VCAC-A .. +``` +