Ressource-Allocation · simtrami · Apr 27, 2020 · Apr 28, 2020 · May 13, 2020 · May 13, 2020
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,7 @@ volume/video/*
 deployment/docker-swarm/dhparam.pem
 deployment/docker-swarm/self.crt
 deployment/docker-swarm/self.key
+deployment/kubernetes/*.yaml
+deployment/kubernetes/yaml/*.yaml
+deployment/certificate/self.crt
+deployment/certificate/self.key
diff --git a/ATTRIBUTION.md b/ATTRIBUTION.md
@@ -0,0 +1,51 @@
+Component: Apache python3-kazoo
+Repository: https://github.com/python-zk/kazoo
+License: Apache License 2.0 (https://github.com/python-zk/kazoo/blob/master/LICENSE)
+
+Component: BeautifulSoup4
+Repository: https://github.com/il-vladislav/BeautifulSoup4/
+License: MIT (https://pypi.org/project/beautifulsoup4/)
+
+Component: confluentinc/cp-docker-images
+Repository: https://github.com/confluentinc/cp-docker-images
+License: Apache License 2.0 (https://github.com/confluentinc/cp-docker-images/blob/5.3.3-post/LICENSE)
+
+Component: dashjs-tmp-nicky
+Repository: https://github.com/Dash-Industry-Forum/dash.js/
+License: BSD 3-clause "New" or "Revised" License (https://github.com/Dash-Industry-Forum/dash.js/blob/development/LICENSE.md)
+
+Component: jQuery (New Wave JavaScript)
+Repository: https://github.com/jquery/jquery
+License: MIT (https://github.com/jquery/jquery/blob/master/LICENSE.txt)
+
+Component: kafka-python
+Repository: https://github.com/dpkp/kafka-python/
+License: MIT (https://github.com/dpkp/kafka-python/blob/master/LICENSE)
+
+Component: What Input
+Repository: https://github.com/ten1seven/what-input
+License: MIT (https://github.com/ten1seven/what-input/blob/master/LICENSE)
+
+Component: Tornado Tornado Web Server
+Repository: https://github.com/tornadoweb/tornado
+License: Apache License 2.0 (https://github.com/tornadoweb/tornado/blob/master/LICENSE)
+
+Component: video-dev hls.js
+Repository: https://github.com/video-dev/hls.js
+License: Apache License 2.0 (https://github.com/video-dev/hls.js/blob/master/LICENSE)
+
+Component: Foundation for Sites
+Repository: https://github.com/zurb/foundation-sites-6
+License: MIT (https://github.com/zurb/foundation-sites-6/blob/develop/LICENSE)
+
+Component: Netflix/vmaf
+Repository: https://github.com/Netflix/vmaf
+License: BSD-2-Clause-Patent (https://github.com/Netflix/vmaf/blob/master/LICENSE)
+
+Component: Jquery-Magnific-Popup
+Repository: https://github.com/dimsemenov/Magnific-Popup
+License: MIT (https://github.com/dimsemenov/Magnific-Popup/blob/master/LICENSE)
+
+Component: bootstrap.min.js
+Repository: https://github.com/twbs/bootstrap
+License: MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,6 +1,30 @@
 cmake_minimum_required (VERSION 2.8)
 
-Project(OVC NONE)
+Project(CDNTranscodeSample NONE)
+
+if (NOT DEFINED REGISTRY)
+    set(REGISTRY "")
+elseif (NOT ${REGISTRY} MATCHES "/$")
+    set(REGISTRY "${REGISTRY}/")
+endif()
+if (NOT DEFINED NVODS)
+    set(NVODS "2")
+endif()
+if (NOT DEFINED NLIVES)
+    set(NLIVES "1")
+endif()
+
+if (NOT DEFINED PLATFORM)
+    set(PLATFORM "Xeon")
+endif()
+
+if (NOT DEFINED SCENARIO)
+    set(SCENARIO "transcode")
+endif()
+
+if (NOT (SCENARIO STREQUAL "cdn"))
+    set(NLIVES "0")
+endif()
 
 file(GLOB dirs "deployment" "*")
 list(REMOVE_DUPLICATES dirs)
@@ -12,3 +36,6 @@ endforeach()
 
 # legal message
 execute_process(COMMAND printf "\nThis script will build third party components licensed under various open source licenses into your container images. The terms under which those components may be used and distributed can be found with the license document that is provided with those components. Please familiarize yourself with those terms to ensure your distribution of those components complies with the terms of those licenses.\n\n")
+execute_process(COMMAND printf "\n-- Setting: PLATFORM=${PLATFORM} SCENARIO=${SCENARIO}\n")
+execute_process(COMMAND printf "-- Setting: NVODS=${NVODS}, NLIVES=${NLIVES}\n")
+execute_process(COMMAND printf "-- Setting: REGISTRY=${REGISTRY}\n")
diff --git a/README.md b/README.md
@@ -1,108 +1,108 @@
-# Open Visual Cloud CDN Transcode Sample
+# PROJECT NOT UNDER ACTIVE MANAGEMENT #  
+This project will no longer be maintained by Intel.  
+Intel has ceased development and contributions including, but not limited to, maintenance, bug fixes, new releases, or updates, to this project.  
+Intel no longer accepts patches to this project.  
+ If you have an ongoing need to use this project, are interested in independently developing it, or would like to maintain patches for the open source software community, please create your own fork of this project.  
+
+
+
+### Open Visual Cloud CDN Transcode Sample
 
 [![Travis Build Status](https://travis-ci.com/OpenVisualCloud/CDN-Transcode-Sample.svg?branch=master)](https://travis-ci.com/OpenVisualCloud/CDN-Transcode-Sample)
 [![Stable release](https://img.shields.io/badge/latest_release-v1.0-green.svg)](https://github.com/OpenVisualCloud/CDN-Transcode-Sample/releases/tag/v1.0)
 [![License](https://img.shields.io/badge/license-BSD_3_Clause-green.svg)](https://github.com/OpenVisualCloud/CDN-Transcode-Sample/blob/master/LICENSE)
 [![Contributions](https://img.shields.io/badge/contributions-welcome-blue.svg)](https://github.com/OpenVisualCloud/CDN-Transcode-Sample/wiki)
 
-Table of Contents
-=================
- * [Open Visual Cloud CDN Transcode Sample](#open-visual-cloud-cdn-transcode-sample)
-   * [Architecture](#architecture)
-   * [What's in this project](#whats-in-this-project)
-   * [System requirements](#system-requirements)
-      * [Operating system](#operating-system)
-   * [How to setup The CDN Transcode Sample](#how-to-setup-the-cdn-transcode-sample)
-      * [Setup the CDN Transcode Sample OS environment(Both of master and slave nodes)](#setup-the-cdn-transcode-sample-os-environmentboth-of-master-and-slave-nodes)
-         * [Install ubuntu18.04.2/CentOS 7.6](#install-ubuntu18042centos-76)
-      * [Setup CDN environment(Both of master and slave nodes)](#setup-cdn-environmentboth-of-master-and-slave-nodes)
-         * [Install the third-party dependency Libraries and tools](#install-the-third-party-dependency-libraries-and-tools)
-         * [Setup docker proxy as follows if you are behind a firewall](#setup-docker-proxy-as-follows-if-you-are-behind-a-firewall)
-      * [Build(Both of master and slave nodes)](#buildboth-of-master-and-slave-nodes)
-      * [Deploy](#deploy)
-         * [Auto deployment using Kubernetes](#auto-deployment-using-kubernetes)
-         * [See Also](#see-also)
-
-The CDN Transcode Sample is an Open Visual Cloud software stack with all required open source ingredients well integrated to provide out-of-box CDN media transcode service, including live streaming and video on demand. It also provides Docker-based media delivery software development environment upon which developer can easily build their specific applications.
-
-# Architecture
-
-The sample implements a reference server-side transcode system over CDN infrastructure, which features `live streaming` and `VOD`.
-
-<IMG src="https://github.com/OpenVisualCloud/CDN-Transcode-Sample/blob/master/volume/html/image/CDN-Transcode-Sample-Arch.png" height="450">
-
-# What's in this project
-The CDN Transcode Sample contains below components:
--  Dockerfiles
--  Python web services source code
--  BASH glue scripts
--  HTML web pages
--  CMakefiles
--  Configuration files
--  Documents
-
-# System requirements
-## Operating system
-The CDN Transcode Sample may run on Linux* 64 bit operating systems. The list below represents the operating systems that the transcode application and library were tested and validated on:
-- Ubuntu* 18.04.2 Server LTS
-- CentOS* 7.6
-
-# How to setup The CDN Transcode Sample
-## Setup the CDN Transcode Sample OS environment(Both of master and slave nodes)
-Install Ubuntu 18.04.2/CentOS 7.6 on CDN-Transcode Server, and configure the IP address & proxy properly.
-### Install ubuntu18.04.2/CentOS 7.6
--  [Download Ubuntu and Install](https://ubuntu.com/download)
--  [Download CentOS and install](https://www.centos.org/download/)
-
-## Setup CDN environment(Both of master and slave nodes)
-### Install the third-party dependency Libraries and tools
+The CDN Transcode Sample is an Open Visual Cloud software stack with all required open source ingredients well integrated to provide out-of-box simple transcode or transcode+CDN service, including live streaming and video on demand. It also provides Docker-based media delivery software development environment upon which developer can easily build their specific applications. 
+
+### Architecture
+
+The sample implements a reference server-side transcode system over CDN infrastructure, which features `live streaming` and `VOD`. Among them, the `VOD` service can run independently to provide a simple transcode service.  
+
+<IMG src="doc/CDN-Transcode-Sample-Arch.png" height="450">
+
+### Software Stacks
+
+The sample is powered by the following Open Visual Cloud software stacks:
+
+- Media transcoding software stack:  
+
+The FFmpeg-based media transcoding stack is used to transcode media content from a higher resolution/quality to a lower resolution/quality. The software stack is optimized for Intel Xeon Scalable Processors and Intel XeonE3 Scalable Processors. 
+
+- Media streaming and Web Hosting software stack:  
+
+The NGINX-based software stack is used to host web services, video content and provide video streaming services. The software stack is optimized for Intel Xeon Scalable Processors.  
+
+### Install Prerequisites:
+
+- **Time Zone**: Check that the timezone setting of your host machine is correctly configured. Timezone is used during build. If you plan to run the sample on a cluster of machines, please make sure to synchronize time among the controller node and worker nodes.
+
+- **Build Tools**: Install `cmake`, `make`, `m4`, `wget` and `gawk` if they are not available on your system.
+
+- **Docker Engine**: 
+
+    - Install [docker engine](https://docs.docker.com/get-docker). Minimum version required: `17.05`. Make sure you setup docker to run as a regular user.
+    - Setup `Kubernetes`. See [Kubernetes Setup](deployment/kubernetes/README.md) for additional setup details.
+    - Setup docker proxy as follows if you are behind a firewall:   
+
 ```
-sudo -E ./script/install_dependency.sh
+sudo mkdir -p /etc/systemd/system/docker.service.d       
+printf "[Service]\nEnvironment=\"HTTPS_PROXY=$https_proxy\" \"NO_PROXY=$no_proxy\"\n" | sudo tee /etc/systemd/system/docker.service.d/proxy.conf       
+sudo systemctl daemon-reload          
+sudo systemctl restart docker     
 ```
-### Setup docker proxy as follows if you are behind a firewall
+
+### Build the Sample  
+
+Run the following command to run the sample as a simple transcoder:  
 ```
-sudo mkdir -p /etc/systemd/system/docker.service.d
-printf "[Service]\nEnvironment=\"HTTPS_PROXY=$https_proxy\" \"NO_PROXY=$no_proxy\"\n" | sudo tee /etc/systemd/system/docker.service.d/proxy.conf
-sudo systemctl daemon-reload
-sudo systemctl restart docker
+mkdir build
+cd build
+cmake ..
+make
 ```
-## Build(Both of master and slave nodes)
-Run below commands to build docker images
+
+Run the following command to run the sample as transcode+CDN:  
 ```
-cd CDN-Transcode-Sample
 mkdir build
 cd build
-cmake ..
+cmake -DSCENARIO=cdn ..
 make
 ```
 
-## Deploy
-### Auto deployment using Kubernetes
+---
+
+If you deploy the sample to a cluster, please configure the sample, as `cmake -DREGISTRY=<registry-url> ..`, to push the sample images to the private docker registry after each build.   
+
+To deploy without a private registry, run `make update` after each build to push the sample images to the cluster nodes (which requires passwordless access from the master node to the worker nodes.)   
 
-**Tips:** It divides into two parts: master or slave ones
-- [Setup Kubernetes master environment for CentOS](https://github.com/OpenVisualCloud/CDN-Transcode-Sample/wiki/Setup-Kubernetes-master-environment-for-CentOS)
-- [Setup Kubernetes master environment for Ubuntu](https://github.com/OpenVisualCloud/CDN-Transcode-Sample/wiki/Setup-Kubernetes-master-environment-for-Ubuntu)
-- [Setup Kubernetes slave environment](https://github.com/OpenVisualCloud/CDN-Transcode-Sample/wiki/Setup-Kubernetes-slave-environment)
-- [Setup NFS environment](https://github.com/OpenVisualCloud/CDN-Transcode-Sample/wiki/Setup-NFS-environment)
+---
+
+### Deploy the Sample
+
+Start/stop the sample with Kubernetes [yaml configurations](deployment/kubernetes/yaml):  
 
-Start CDN transcode service
 ```
+make volume
 make start_kubernetes
+...
+make stop_kubernetes
 ```
-**Tips:** [Configuration example for Kubernetes deploy](https://github.com/OpenVisualCloud/CDN-Transcode-Sample/wiki/Configuration-example-for-Kubernetes-deploy)
 
-Stop CDN transcode service
+Start/stop the sample with Kubernetes [Helm charts](deployment/kubernetes/helm):  
+
 ```
-make stop_kubernetes
+make volume
+make start_helm
+...
+make stop_helm
 ```
 
-____
-### See Also
-- [Deploy on Xeon E5 using docker swarm](https://github.com/OpenVisualCloud/CDN-Transcode-Sample/wiki/Deploy-on-Xeon-E5-using-docker-swarm)
-- [Deploy on Xeon E5 using Kubernetes](https://github.com/OpenVisualCloud/CDN-Transcode-Sample/wiki/Deploy-on-Xeon-E5-using-Kubernetes)
-- [Deploy on Xeon E3 with Gen GFX using Kubernetes](https://github.com/OpenVisualCloud/CDN-Transcode-Sample/wiki/Deploy-on-Xeon-E3-with-Gen-GFX-using-Kubernetes)
-- [Deploy on VCA2 with Gen GFX using Kubernetes](https://github.com/OpenVisualCloud/CDN-Transcode-Sample/wiki/Deploy-on-VCA2-with-Gen-GFX-using-Kubernetes)
-- [Setup proxy server](https://github.com/OpenVisualCloud/CDN-Transcode-Sample/wiki/Setup-proxy-server)
-- [Setup Kubernetes Logging](https://github.com/OpenVisualCloud/CDN-Transcode-Sample/wiki/Setup-Kubernetes-logging-environment)
-- [Setup Kubernetes Monitoring](https://github.com/OpenVisualCloud/CDN-Transcode-Sample/wiki/Setup-Kubernetes-monitoring-environment)
-- [Remove Kubernetes environment](https://github.com/OpenVisualCloud/CDN-Transcode-Sample/wiki/Remove-Kubernetes-environment)
+For the `transcode` scenario, look at the logs of the `benchmark` pod for the batch transcoding summary. For the `cdn` scenario, point your browser to `https://<your-host>` to watch the list of video clips via `DASH` or `HLS`.   
+
+# See Also
+
+- [Kubernetes Setup](deployment/kubernetes/README.md)   
+- [Build Options](doc/cmake.md)   
+- [Reference Architecture](https://networkbuilders.intel.com/solutionslibrary/container-bare-metal-for-2nd-generation-intel-xeon-scalable-processor)   
+
diff --git a/benchmark/.dockerignore b/benchmark/.dockerignore
@@ -0,0 +1,3 @@
+CMakeLists.txt
+*.m4
+test/*
diff --git a/benchmark/CMakeLists.txt b/benchmark/CMakeLists.txt
@@ -0,0 +1,5 @@
+if (SCENARIO STREQUAL "transcode")
+    set(service "tc_benchmark_service")
+    include("${CMAKE_SOURCE_DIR}/script/service.cmake")
+    add_dependencies(build_${service} build_tc_common)
+endif()
diff --git a/benchmark/Dockerfile b/benchmark/Dockerfile
@@ -0,0 +1,15 @@
+
+FROM tc_common
+
+Run apt-get update -q && apt-get install -y -q python3-kafka python3-kazoo && rm -rf /var/lib/apt/lists/*
+
+COPY *.py   /home/
+COPY *.json   /home/
+CMD  ["/bin/bash","-c","/home/main.py"]
+WORKDIR /home
+
+####
+ARG  UID
+RUN  mkdir -p /var/www/archive
+USER ${UID}
+####
diff --git a/benchmark/build.sh b/benchmark/build.sh
@@ -0,0 +1,6 @@
+#!/bin/bash -e
+
+IMAGE="tc_benchmark_service"
+DIR=$(dirname $(readlink -f "$0"))
+
+. "${DIR}/../script/build.sh"