├── serverless-docker-voting-app ├── .gitignore ├── entrypoint │ ├── Dockerfile │ └── main.go ├── vote │ ├── requirements.txt │ ├── Dockerfile │ ├── app.py │ └── templates │ │ └── index.html ├── Makefile ├── result │ ├── Dockerfile │ ├── app.pl │ └── public │ │ ├── app.js │ │ └── index.html ├── docker-compose.yml ├── docker-compose.build.yml ├── record-vote-task │ ├── Dockerfile │ ├── src │ │ └── main │ │ │ └── java │ │ │ └── worker │ │ │ └── Worker.java │ └── pom.xml ├── README.md ├── README_CH.md └── LICENSE ├── circleci ├── requirements.txt ├── tests │ ├── Dockerfile │ ├── render.js │ └── tests.sh ├── docker-compose.yml ├── Dockerfile ├── circle.yml ├── app.py ├── templates │ └── index.html ├── static │ └── stylesheets │ │ └── style.css ├── README.md └── LICENSE ├── minimal_nodejs ├── Dockerfile ├── compile.sh ├── package.json ├── index.js ├── Makefile ├── copy_ldd.sh └── README.md ├── example-voting-app ├── vote │ ├── requirements.txt │ ├── Dockerfile │ ├── app.py │ ├── templates │ │ └── index.html │ └── static │ │ └── stylesheets │ │ └── style.css ├── architecture.png ├── bd3-architecture.png ├── result │ ├── tests │ │ ├── Dockerfile │ │ ├── render.js │ │ └── tests.sh │ ├── Dockerfile │ ├── package.json │ ├── .vscode │ │ └── launch.json │ ├── docker-compose.test.yml │ ├── views │ │ ├── app.js │ │ ├── index.html │ │ └── stylesheets │ │ │ └── style.css │ └── server.js ├── worker.net │ ├── Dockerfile │ └── src │ │ └── Worker │ │ ├── project.json │ │ └── Program.cs ├── docker-compose.yml ├── docker-compose.net.yml ├── worker │ ├── Dockerfile │ ├── pom.xml │ └── src │ │ └── main │ │ └── java │ │ └── worker │ │ └── Worker.java ├── README.md └── README_CH.md ├── compose_dns ├── webproxy │ ├── Dockerfile │ └── proxy.conf ├── docker-compose.yml └── README.md ├── compose_galera_wordpress ├── wordpress.yml ├── galera.yml ├── galera_wordpress.yml └── README.md ├── README.md ├── swarm_galera_wordpress └── README.md └── LICENSE /serverless-docker-voting-app/.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | -------------------------------------------------------------------------------- /serverless-docker-voting-app/entrypoint/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM golang:1.7-onbuild 2 | -------------------------------------------------------------------------------- /circleci/requirements.txt: -------------------------------------------------------------------------------- 1 | Flask==3.0.0 2 | Redis==5.0.1 3 | gunicorn==21.2.0 4 | -------------------------------------------------------------------------------- /minimal_nodejs/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM scratch 2 | ADD build.tar.gz / 3 | CMD ["/app/minimal"] 4 | -------------------------------------------------------------------------------- /example-voting-app/vote/requirements.txt: -------------------------------------------------------------------------------- 1 | Flask==3.0.0 2 | Redis==5.0.1 3 | gunicorn==21.2.0 4 | -------------------------------------------------------------------------------- /serverless-docker-voting-app/vote/requirements.txt: -------------------------------------------------------------------------------- 1 | Flask==3.0.0 2 | Redis==5.0.1 3 | dockerrun==0.1.4 4 | -------------------------------------------------------------------------------- /compose_dns/webproxy/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM nginx:alpine 2 | RUN rm /etc/nginx/conf.d/* 3 | COPY proxy.conf /etc/nginx/conf.d/ 4 | -------------------------------------------------------------------------------- /circleci/tests/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node 2 | RUN npm install -g phantomjs 3 | ADD . /app 4 | WORKDIR /app 5 | CMD ["/app/tests.sh"] 6 | -------------------------------------------------------------------------------- /example-voting-app/architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/philipz/docker_workshop/HEAD/example-voting-app/architecture.png -------------------------------------------------------------------------------- /example-voting-app/bd3-architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/philipz/docker_workshop/HEAD/example-voting-app/bd3-architecture.png -------------------------------------------------------------------------------- /compose_dns/webproxy/proxy.conf: -------------------------------------------------------------------------------- 1 | server { 2 | listen 80; 3 | 4 | location / { 5 | proxy_pass http://webapp:8000; 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /example-voting-app/result/tests/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node 2 | RUN npm install -g phantomjs 3 | ADD . /app 4 | WORKDIR /app 5 | CMD ["/app/tests.sh"] 6 | -------------------------------------------------------------------------------- /serverless-docker-voting-app/Makefile: -------------------------------------------------------------------------------- 1 | 2 | default: run 3 | 4 | run: build 5 | docker-compose up --build 6 | 7 | build: 8 | docker-compose -f docker-compose.build.yml build 9 | -------------------------------------------------------------------------------- /compose_dns/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '2' 2 | 3 | services: 4 | webapp: 5 | image: philipz/minimal 6 | 7 | webproxy: 8 | build: webproxy 9 | ports: 10 | - "80:80" 11 | -------------------------------------------------------------------------------- /serverless-docker-voting-app/result/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM perl:5 2 | RUN curl -L https://cpanmin.us | perl - -M https://cpan.metacpan.org -n Mojolicious Mojo::Pg 3 | COPY . /usr/src/myapp 4 | WORKDIR /usr/src/myapp 5 | CMD [ "perl", "./app.pl" , "cgi"] 6 | -------------------------------------------------------------------------------- /minimal_nodejs/compile.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | cd /app 3 | npm install 4 | npm install -g enclose 5 | enclose --loglevel info -o ./$2 ./$1 6 | ./copy_ldd.sh $2 build 7 | cd build && tar zcf build.tar.gz * && mv build.tar.gz ../ && cd /app && rm -rf build 8 | exit 9 | -------------------------------------------------------------------------------- /serverless-docker-voting-app/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "2" 2 | 3 | services: 4 | entrypoint: 5 | build: entrypoint 6 | ports: 7 | - 80:80 8 | volumes: 9 | - "/var/run/docker.sock:/var/run/docker.sock" 10 | 11 | db: 12 | image: postgres:9.4 13 | -------------------------------------------------------------------------------- /example-voting-app/worker.net/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM microsoft/dotnet:1.0.0-preview1 2 | 3 | WORKDIR /app 4 | 5 | ADD src/ /app/src/ 6 | 7 | RUN dotnet restore -v minimal src/ \ 8 | && dotnet publish -c Release -o ./ src/Worker/ \ 9 | && rm -rf src/ $HOME/.nuget/ 10 | 11 | CMD dotnet Worker.dll 12 | -------------------------------------------------------------------------------- /serverless-docker-voting-app/docker-compose.build.yml: -------------------------------------------------------------------------------- 1 | version: "2" 2 | 3 | services: 4 | vote: 5 | build: ./vote 6 | image: bfirsh/serverless-vote 7 | 8 | result: 9 | build: ./result 10 | image: bfirsh/serverless-result 11 | 12 | record-vote-task: 13 | build: ./record-vote-task 14 | image: bfirsh/serverless-record-vote-task 15 | -------------------------------------------------------------------------------- /minimal_nodejs/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "minimal_docker", 3 | "version": "1.0.0", 4 | "description": "For COSCUP 2016 Docker Advanced Workshop", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1", 8 | "start": "node index.js" 9 | }, 10 | "author": "Philipz", 11 | "license": "ISC" 12 | } 13 | -------------------------------------------------------------------------------- /compose_galera_wordpress/wordpress.yml: -------------------------------------------------------------------------------- 1 | version: "2" 2 | 3 | services: 4 | wordpress: 5 | image: wordpress 6 | networks: 7 | - mysql 8 | environment: 9 | - WORDPRESS_DB_HOST=slave:3306 10 | - WORDPRESS_DB_USER=wordpress 11 | - WORDPRESS_DB_PASSWORD=PASSWORD 12 | ports: 13 | - "80:80" 14 | 15 | networks: 16 | mysql: 17 | -------------------------------------------------------------------------------- /circleci/tests/render.js: -------------------------------------------------------------------------------- 1 | var system = require('system'); 2 | var page = require('webpage').create(); 3 | var url = system.args[1]; 4 | 5 | page.onLoadFinished = function() { 6 | setTimeout(function(){ 7 | console.log(page.content); 8 | phantom.exit(); 9 | }, 1000); 10 | }; 11 | 12 | page.open(url, function() { 13 | page.evaluate(function() { 14 | }); 15 | }); 16 | -------------------------------------------------------------------------------- /example-voting-app/result/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node:5.11.0-slim 2 | 3 | WORKDIR /app 4 | 5 | RUN npm install -g nodemon 6 | ADD package.json /app/package.json 7 | RUN npm config set registry http://registry.npmjs.org 8 | RUN npm install && npm ls 9 | RUN mv /app/node_modules /node_modules 10 | 11 | ADD . /app 12 | 13 | ENV PORT 80 14 | EXPOSE 80 15 | 16 | CMD ["node", "server.js"] 17 | -------------------------------------------------------------------------------- /example-voting-app/result/tests/render.js: -------------------------------------------------------------------------------- 1 | var system = require('system'); 2 | var page = require('webpage').create(); 3 | var url = system.args[1]; 4 | 5 | page.onLoadFinished = function() { 6 | setTimeout(function(){ 7 | console.log(page.content); 8 | phantom.exit(); 9 | }, 1000); 10 | }; 11 | 12 | page.open(url, function() { 13 | page.evaluate(function() { 14 | }); 15 | }); 16 | -------------------------------------------------------------------------------- /circleci/tests/tests.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | curl -sS -X POST --data "vote=b" http://localhost:5000 > /dev/null 3 | sleep 10 4 | if phantomjs render.js http://localhost | grep -q '1 vote'; then 5 | echo -e "\e[42m------------" 6 | echo -e "\e[92mTests passed" 7 | echo -e "\e[42m------------" 8 | exit 0 9 | fi 10 | echo -e "\e[41m------------" 11 | echo -e "\e[91mTests failed" 12 | echo -e "\e[41m------------" 13 | exit 1 14 | -------------------------------------------------------------------------------- /example-voting-app/result/tests/tests.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | curl -sS -X POST --data "vote=b" http://localhost:5000 > /dev/null 3 | sleep 10 4 | if phantomjs render.js http://localhost | grep -q '1 vote'; then 5 | echo -e "\e[42m------------" 6 | echo -e "\e[92mTests passed" 7 | echo -e "\e[42m------------" 8 | exit 0 9 | fi 10 | echo -e "\e[41m------------" 11 | echo -e "\e[91mTests failed" 12 | echo -e "\e[41m------------" 13 | exit 1 14 | -------------------------------------------------------------------------------- /minimal_nodejs/index.js: -------------------------------------------------------------------------------- 1 | var os = require("os"); 2 | 3 | var ip = "0.0.0.0", 4 | port = 8000, 5 | http = require('http'); 6 | 7 | function onRequest(request, response) { 8 | console.log("Request received."); 9 | response.writeHead(200, {"Content-Type": "text/plain"}); 10 | response.write("Hello World " + os.hostname()); 11 | response.end(); 12 | } 13 | http.createServer(onRequest).listen(port, ip); 14 | console.log("Server has started."); 15 | -------------------------------------------------------------------------------- /circleci/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "2" 2 | 3 | services: 4 | vote: 5 | image: philipz/votingapp_vote 6 | command: python app.py 7 | ports: 8 | - "5000:80" 9 | 10 | redis: 11 | image: redis:alpine 12 | ports: ["6379"] 13 | 14 | worker: 15 | image: philipz/votingapp_worker 16 | 17 | db: 18 | image: postgres:9.4 19 | 20 | result: 21 | image: philipz/votingapp_result 22 | ports: 23 | - "80:80" 24 | - "5858:5858" 25 | -------------------------------------------------------------------------------- /example-voting-app/result/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "result", 3 | "version": "1.0.0", 4 | "description": "", 5 | "main": "server.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "author": "", 10 | "license": "MIT", 11 | "dependencies": { 12 | "body-parser": "^1.20.2", 13 | "cookie-parser": "^1.4.6", 14 | "express": "^4.18.2", 15 | "method-override": "^3.0.0", 16 | "async": "^3.2.5", 17 | "pg": "^8.11.3", 18 | "socket.io": "^4.6.1" 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /example-voting-app/result/.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "0.2.0", 3 | "configurations": [ 4 | { 5 | "name": "Attach", 6 | "type": "node", 7 | "request": "attach", 8 | "port": 5858, 9 | "address": "localhost", 10 | "restart": true, 11 | "sourceMaps": false, 12 | "outDir": null, 13 | "localRoot": "${workspaceRoot}", 14 | "remoteRoot": "/app", 15 | "timeout": 10000 16 | } 17 | ] 18 | } 19 | -------------------------------------------------------------------------------- /serverless-docker-voting-app/vote/Dockerfile: -------------------------------------------------------------------------------- 1 | # Using official python runtime base image 2 | FROM python:2.7-alpine 3 | 4 | # Set the application directory 5 | WORKDIR /app 6 | 7 | # Install our requirements.txt 8 | ADD requirements.txt /app/requirements.txt 9 | RUN pip install -r requirements.txt 10 | 11 | # Copy our code from the current folder to /app inside the container 12 | ADD . /app 13 | 14 | # Make port 80 available for links and/or publish 15 | EXPOSE 80 16 | 17 | # Define our command to be run when launching the container 18 | CMD ["python", "app.py"] 19 | -------------------------------------------------------------------------------- /compose_galera_wordpress/galera.yml: -------------------------------------------------------------------------------- 1 | version: "2" 2 | 3 | services: 4 | master: 5 | image: erkules/galera:basic 6 | container_name: master 7 | volumes: 8 | - /data:/var/lib/mysql 9 | networks: 10 | - mysql 11 | command: --wsrep-cluster-name=local-test --wsrep-cluster-address=gcomm:// 12 | 13 | slave: 14 | depends_on: 15 | - master 16 | image: erkules/galera:basic 17 | networks: 18 | - mysql 19 | command: --wsrep-cluster-name=local-test --wsrep-cluster-address=gcomm://master 20 | 21 | networks: 22 | mysql: 23 | -------------------------------------------------------------------------------- /example-voting-app/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "2" 2 | 3 | services: 4 | vote: 5 | build: ./vote 6 | command: python app.py 7 | volumes: 8 | - ./vote:/app 9 | ports: 10 | - "5000:80" 11 | 12 | redis: 13 | image: redis:alpine 14 | ports: ["6379"] 15 | 16 | worker: 17 | build: ./worker 18 | 19 | db: 20 | image: postgres:9.4 21 | 22 | result: 23 | build: ./result 24 | command: nodemon --debug server.js 25 | volumes: 26 | - ./result:/app 27 | ports: 28 | - "80:80" 29 | - "5858:5858" 30 | -------------------------------------------------------------------------------- /minimal_nodejs/Makefile: -------------------------------------------------------------------------------- 1 | NAME = minimal 2 | APP_NAME = index.js 3 | NODE_VERSION = 6.0.0 4 | 5 | PWD := $(shell pwd) 6 | 7 | .PHONY: all 8 | 9 | all: clean build 10 | 11 | build: 12 | docker run -ti --rm -v $(PWD):/app node:$(NODE_VERSION) /app/compile.sh $(APP_NAME) $(NAME) 13 | echo 'FROM scratch\nADD build.tar.gz /\nCMD ["/app/$(NAME)"]' > Dockerfile 14 | docker build -t philipz/$(NAME) . 15 | 16 | clean: clean-exe clean-build 17 | 18 | clean-docker: 19 | docker rmi philipz/$(NAME) 20 | clean-exe: 21 | sudo rm -f $(NAME) 22 | clean-build: 23 | sudo rm -rf build 24 | sudo rm -f build.tar.gz 25 | -------------------------------------------------------------------------------- /serverless-docker-voting-app/result/app.pl: -------------------------------------------------------------------------------- 1 | use Mojolicious::Lite; 2 | use Mojo::Pg; 3 | 4 | helper pg => sub { state $pg = Mojo::Pg->new('postgresql://postgres@db/postgres') }; 5 | 6 | get '/votes' => sub { 7 | my $c = shift; 8 | 9 | my %data; 10 | my $results = $c->pg->db->query("SELECT vote, COUNT(id) AS count FROM votes GROUP BY vote"); 11 | while (my $next = $results->hash) { 12 | $data{$next->{vote}} = $next->{count}; 13 | } 14 | $c->render(json => {%data}); 15 | }; 16 | 17 | get '/' => sub { 18 | my $c = shift; 19 | $c->app->static->serve($c, 'index.html'); 20 | }; 21 | 22 | app->start; 23 | -------------------------------------------------------------------------------- /circleci/Dockerfile: -------------------------------------------------------------------------------- 1 | # Using official python runtime base image 2 | FROM python:2.7-alpine 3 | 4 | # Set the application directory 5 | WORKDIR /app 6 | 7 | # Install our requirements.txt 8 | ADD requirements.txt /app/requirements.txt 9 | RUN pip install -r requirements.txt 10 | 11 | # Copy our code from the current folder to /app inside the container 12 | ADD . /app 13 | 14 | # Make port 80 available for links and/or publish 15 | EXPOSE 80 16 | 17 | # Define our command to be run when launching the container 18 | CMD ["gunicorn", "app:app", "-b", "0.0.0.0:80", "--log-file", "-", "--access-logfile", "-", "--workers", "4", "--keep-alive", "0"] 19 | -------------------------------------------------------------------------------- /example-voting-app/docker-compose.net.yml: -------------------------------------------------------------------------------- 1 | version: "2" 2 | 3 | services: 4 | vote: 5 | build: ./vote 6 | command: python app.py 7 | volumes: 8 | - ./vote:/app 9 | ports: 10 | - "5000:80" 11 | 12 | redis: 13 | image: redis:alpine 14 | ports: ["6379"] 15 | 16 | worker.net: 17 | build: ./worker.net 18 | depends_on: 19 | - redis 20 | - db 21 | 22 | db: 23 | image: postgres:9.4 24 | 25 | result: 26 | build: ./result 27 | command: nodemon --debug server.js 28 | volumes: 29 | - ./result:/app 30 | ports: 31 | - "80:80" 32 | - "5858:5858" 33 | -------------------------------------------------------------------------------- /example-voting-app/vote/Dockerfile: -------------------------------------------------------------------------------- 1 | # Using official python runtime base image 2 | FROM python:2.7-alpine 3 | 4 | # Set the application directory 5 | WORKDIR /app 6 | 7 | # Install our requirements.txt 8 | ADD requirements.txt /app/requirements.txt 9 | RUN pip install -r requirements.txt 10 | 11 | # Copy our code from the current folder to /app inside the container 12 | ADD . /app 13 | 14 | # Make port 80 available for links and/or publish 15 | EXPOSE 80 16 | 17 | # Define our command to be run when launching the container 18 | CMD ["gunicorn", "app:app", "-b", "0.0.0.0:80", "--log-file", "-", "--access-logfile", "-", "--workers", "4", "--keep-alive", "0"] 19 | -------------------------------------------------------------------------------- /example-voting-app/worker.net/src/Worker/project.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Worker", 3 | "buildOptions": { 4 | "emitEntryPoint": true, 5 | "warningsAsErrors": true 6 | }, 7 | "dependencies": { 8 | "StackExchange.Redis": "1.1.604-alpha", 9 | "Npgsql": "3.1.3", 10 | "Newtonsoft.Json": "9.0.1-beta1", 11 | "Microsoft.NETCore.App": { 12 | "type": "platform", 13 | "version": "1.0.0-rc2-3002702" 14 | } 15 | }, 16 | "frameworks": { 17 | "netcoreapp1.0": { } 18 | }, 19 | "runtimeOptions": { 20 | "configProperties": { 21 | "System.GC.Server": true 22 | } 23 | } 24 | } -------------------------------------------------------------------------------- /serverless-docker-voting-app/record-vote-task/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM java:openjdk-8-jdk-alpine 2 | 3 | RUN MAVEN_VERSION=3.3.3 \ 4 | && cd /usr/share \ 5 | && wget http://archive.apache.org/dist/maven/maven-3/$MAVEN_VERSION/binaries/apache-maven-$MAVEN_VERSION-bin.tar.gz -O - | tar xzf - \ 6 | && mv /usr/share/apache-maven-$MAVEN_VERSION /usr/share/maven \ 7 | && ln -s /usr/share/maven/bin/mvn /usr/bin/mvn 8 | 9 | WORKDIR /code 10 | 11 | ADD pom.xml /code/pom.xml 12 | RUN ["mvn", "dependency:resolve"] 13 | RUN ["mvn", "verify"] 14 | 15 | # Adding source, compile and package into a fat jar 16 | ADD src /code/src 17 | RUN ["mvn", "package"] 18 | 19 | ENTRYPOINT ["java", "-jar", "target/worker-jar-with-dependencies.jar"] 20 | -------------------------------------------------------------------------------- /circleci/circle.yml: -------------------------------------------------------------------------------- 1 | machine: 2 | pre: 3 | - curl -sSL https://s3.amazonaws.com/circle-downloads/install-circleci-docker.sh | bash -s -- 1.10.0 4 | services: 5 | - docker 6 | node: 7 | version: 0.10.22 8 | 9 | dependencies: 10 | override: 11 | - docker info 12 | - docker -v 13 | - docker build -t philipz/votingapp_vote . 14 | test: 15 | override: 16 | - curl -L https://github.com/docker/compose/releases/download/1.8.0/docker-compose-`uname -s`-`uname -m` > ./docker-compose 17 | - chmod +x ./docker-compose 18 | - ./docker-compose -v 19 | - ./docker-compose up -d 20 | - npm install -g phantomjs 21 | - cd tests && ./tests.sh 22 | deployment: 23 | hub: 24 | branch: master 25 | commands: 26 | - docker login -e $DOCKER_EMAIL -u $DOCKER_USER -p $DOCKER_PASS 27 | - docker push philipz/votingapp_vote 28 | -------------------------------------------------------------------------------- /example-voting-app/worker/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM java:openjdk-8-jdk-alpine 2 | 3 | #RUN apt-get update -qq && apt-get install -y maven && apt-get clean 4 | 5 | RUN MAVEN_VERSION=3.3.3 \ 6 | && cd /usr/share \ 7 | && wget http://archive.apache.org/dist/maven/maven-3/$MAVEN_VERSION/binaries/apache-maven-$MAVEN_VERSION-bin.tar.gz -O - | tar xzf - \ 8 | && mv /usr/share/apache-maven-$MAVEN_VERSION /usr/share/maven \ 9 | && ln -s /usr/share/maven/bin/mvn /usr/bin/mvn 10 | 11 | WORKDIR /code 12 | 13 | ADD pom.xml /code/pom.xml 14 | RUN ["mvn", "dependency:resolve"] 15 | RUN ["mvn", "verify"] 16 | 17 | # Adding source, compile and package into a fat jar 18 | ADD src /code/src 19 | RUN ["mvn", "package"] 20 | 21 | #CMD ["/usr/lib/jvm/java-7-openjdk-amd64/bin/java", "-jar", "target/worker-jar-with-dependencies.jar"] 22 | CMD ["java", "-jar", "target/worker-jar-with-dependencies.jar"] 23 | -------------------------------------------------------------------------------- /example-voting-app/README.md: -------------------------------------------------------------------------------- 1 | Instavote 2 | ========= 3 | 4 | Getting started 5 | --------------- 6 | 7 | Download [Docker for Mac or Windows](https://www.docker.com). 8 | 9 | Run in this directory: 10 | 11 | $ docker-compose up 12 | 13 | The app will be running at [http://localhost:5000](http://localhost:5000), and the results will be at [http://localhost:5001](http://localhost:5001). 14 | 15 | Architecture 16 | ----- 17 | 18 | Java 19 | 20 | ![Java Worker Architecture diagram](bd3-architecture.png) 21 | 22 | .Net 23 | 24 | ![.Net Worker Architecture diagram](architecture.png) 25 | 26 | * A Python webapp which lets you vote between two options 27 | * A Redis queue which collects new votes 28 | * A Java worker which consumes votes and stores them in… 29 | * A Postgres database backed by a Docker volume 30 | * A Node.js webapp which shows the results of the voting in real time 31 | 32 | -------------------------------------------------------------------------------- /compose_galera_wordpress/galera_wordpress.yml: -------------------------------------------------------------------------------- 1 | version: "2" 2 | 3 | services: 4 | master: 5 | image: erkules/galera:basic 6 | container_name: master 7 | volumes: 8 | - /data:/var/lib/mysql 9 | networks: 10 | - mysql 11 | command: --wsrep-cluster-name=local-test --wsrep-cluster-address=gcomm:// 12 | 13 | slave: 14 | depends_on: 15 | - master 16 | image: erkules/galera:basic 17 | networks: 18 | - mysql 19 | command: --wsrep-cluster-name=local-test --wsrep-cluster-address=gcomm://master 20 | 21 | wordpress: 22 | depends_on: 23 | - slave 24 | image: wordpress 25 | networks: 26 | - mysql 27 | - proxy 28 | environment: 29 | - WORDPRESS_DB_HOST=slave:3306 30 | - WORDPRESS_DB_USER=wordpress 31 | - WORDPRESS_DB_PASSWORD=PASSWORD 32 | ports: 33 | - "80:80" 34 | 35 | networks: 36 | mysql: 37 | proxy: 38 | -------------------------------------------------------------------------------- /serverless-docker-voting-app/README.md: -------------------------------------------------------------------------------- 1 | # Serverless Docker Example Voting App 2 | 3 | This is a serverless app built with Docker. Read more in the [Serverless Docker repository](https://github.com/bfirsh/serverless-docker) or [Blog](https://blog.docker.com/2016/06/building-serverless-apps-with-docker/). 4 | 5 | ## Architecture 6 | 7 | It consists of a simple entrypoint server that listens for HTTP requests. All of the other functionality of the app is run on-demand as Docker containers for each HTTP request: 8 | 9 | - **vote**: The voting web app, as a CGI container that serves a single HTTP request. 10 | - **record-vote-task**: A container which processes a vote in the background, run by the vote app. 11 | - **result**: The result web app, as a CGI container. 12 | 13 | ## Running 14 | 15 | Run in this directory: 16 | 17 | $ make 18 | 19 | The app will be running at http://localhost/vote/ and http://localhost/result/ 20 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | #For 2016 COSCUP Advanced Docker Workshop 2 | Supports by [Katacoda](https://www.katacoda.com/) & [Microsoft Azure](https://portal.azure.com/), Thank you!!! m(_ _)m 3 | 4 | ##[Slide](https://goo.gl/GH7jTa) 5 | 6 | ##[基礎 Docker 操作](https://philipz.github.io/docker.html) 7 | 8 | ##Workshop Lab. List: 9 | 1. [Docker 官方 Web 投票微服務範例](https://www.katacoda.com/docker/courses/docker2016/1) 10 | 2. [Docker Compose & CircleCI](https://www.katacoda.com/philipz/scenarios/7) 11 | 3. [Node.js 最精簡映像檔建置](https://www.katacoda.com/philipz/scenarios/2) 12 | 4. [Docker Compose 和 Service Discovery](http://www.katacoda.com/docker/courses/docker2016/2) 13 | 5. [Docker Compose for MySQL Cluster & WordPress](http://www.katacoda.com/docker/courses/docker2016/4) 14 | 6. [Docker 1.12 Swarm 和 MySQL Cluster & WordPress](https://www.katacoda.com/philipz/courses/swarm/1) 15 | 7. [Serverless 架構 & Docker (DockerCon 2016 Hackathon 作品)](https://www.katacoda.com/philipz/scenarios/8) 16 | -------------------------------------------------------------------------------- /minimal_nodejs/copy_ldd.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | if [ $# != 2 ] ; then 4 | echo "usage $0 PATH_TO_BINARY TARGET_FOLDER" 5 | exit 1 6 | fi 7 | 8 | PATH_TO_BINARY="$1" 9 | TARGET_FOLDER="$2" 10 | 11 | # if we cannot find the the binary we have to abort 12 | if [ ! -f "$PATH_TO_BINARY" ] ; then 13 | echo "The file '$PATH_TO_BINARY' was not found. Aborting!" 14 | exit 1 15 | fi 16 | 17 | # copy the binary to the target folder 18 | # create directories if required 19 | echo "---> copy binary itself" 20 | mkdir -p "$TARGET_FOLDER"/app 21 | cp --parents -v "$PATH_TO_BINARY" "$TARGET_FOLDER"/app 22 | cp --parents -v -R node_modules "$TARGET_FOLDER"/app 23 | 24 | 25 | # copy the required shared libs to the target folder 26 | # create directories if required 27 | echo "---> copy libraries" 28 | for lib in `ldd "$PATH_TO_BINARY" | cut -d'>' -f2 | awk '{print $1}' | grep "/"` ; do 29 | if [ -f "$lib" ] ; then 30 | cp -v --parents "$lib" "$TARGET_FOLDER" 31 | fi 32 | done 33 | echo "Done!!!" 34 | -------------------------------------------------------------------------------- /serverless-docker-voting-app/entrypoint/main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "net/http" 5 | 6 | "github.com/bfirsh/go-dcgi" 7 | "github.com/docker/engine-api/client" 8 | "github.com/docker/engine-api/types/container" 9 | ) 10 | 11 | func main() { 12 | cli, err := client.NewClient("unix:///var/run/docker.sock", "v1.23", nil, nil) 13 | if err != nil { 14 | panic(err) 15 | } 16 | 17 | hostConfig := &container.HostConfig{ 18 | NetworkMode: "serverlessdockervotingapp_default", 19 | Binds: []string{"/var/run/docker.sock:/var/run/docker.sock"}, 20 | } 21 | 22 | http.Handle("/vote/", &dcgi.Handler{ 23 | Image: "bfirsh/serverless-vote", 24 | Client: cli, 25 | HostConfig: hostConfig, 26 | Root: "/vote", // strip /vote from all URLs 27 | }) 28 | http.Handle("/result/", &dcgi.Handler{ 29 | Image: "bfirsh/serverless-result", 30 | Client: cli, 31 | HostConfig: hostConfig, 32 | Root: "/result", 33 | }) 34 | http.ListenAndServe(":80", nil) 35 | } 36 | -------------------------------------------------------------------------------- /example-voting-app/result/docker-compose.test.yml: -------------------------------------------------------------------------------- 1 | version: '2' 2 | 3 | services: 4 | 5 | sut: 6 | build: ./tests/ 7 | depends_on: 8 | - vote 9 | - result 10 | - worker 11 | networks: 12 | - front-tier 13 | 14 | vote: 15 | build: ../vote/ 16 | ports: ["80"] 17 | depends_on: 18 | - redis 19 | - db 20 | networks: 21 | - front-tier 22 | - back-tier 23 | 24 | result: 25 | build: . 26 | ports: ["80"] 27 | depends_on: 28 | - redis 29 | - db 30 | networks: 31 | - front-tier 32 | - back-tier 33 | 34 | worker: 35 | build: ../worker/ 36 | depends_on: 37 | - redis 38 | - db 39 | networks: 40 | - back-tier 41 | 42 | redis: 43 | image: redis:alpine 44 | ports: ["6379"] 45 | networks: 46 | - back-tier 47 | 48 | db: 49 | image: postgres:9.4 50 | volumes: 51 | - "db-data:/var/lib/postgresql/data" 52 | networks: 53 | - back-tier 54 | 55 | volumes: 56 | db-data: 57 | 58 | networks: 59 | front-tier: 60 | back-tier: 61 | -------------------------------------------------------------------------------- /serverless-docker-voting-app/vote/app.py: -------------------------------------------------------------------------------- 1 | from flask import Flask, render_template, request, make_response 2 | import socket 3 | from wsgiref.handlers import CGIHandler 4 | import os 5 | import random 6 | import dockerrun 7 | 8 | option_a = os.getenv('OPTION_A', "Cats") 9 | option_b = os.getenv('OPTION_B', "Dogs") 10 | hostname = socket.gethostname() 11 | 12 | app = Flask(__name__) 13 | 14 | client = dockerrun.from_env(version="1.24") 15 | 16 | @app.route("/", methods=['POST','GET']) 17 | def hello(): 18 | voter_id = request.cookies.get('voter_id') 19 | if not voter_id: 20 | voter_id = hex(random.getrandbits(64))[2:-1] 21 | 22 | vote = None 23 | 24 | if request.method == 'POST': 25 | vote = request.form['vote'] 26 | client.run( 27 | "bfirsh/serverless-record-vote-task", 28 | [voter_id, vote], 29 | detach=True, 30 | network_mode="serverlessdockervotingapp_default" 31 | ) 32 | 33 | resp = make_response(render_template( 34 | 'index.html', 35 | option_a=option_a, 36 | option_b=option_b, 37 | hostname=hostname, 38 | vote=vote, 39 | )) 40 | resp.set_cookie('voter_id', voter_id) 41 | return resp 42 | 43 | 44 | if __name__ == "__main__": 45 | CGIHandler().run(app) 46 | -------------------------------------------------------------------------------- /circleci/app.py: -------------------------------------------------------------------------------- 1 | from flask import Flask, render_template, request, make_response, g 2 | from redis import Redis 3 | import os 4 | import socket 5 | import random 6 | import json 7 | 8 | option_a = os.getenv('OPTION_A', "Cats") 9 | option_b = os.getenv('OPTION_B', "Dogs") 10 | hostname = socket.gethostname() 11 | 12 | app = Flask(__name__) 13 | 14 | def get_redis(): 15 | if not hasattr(g, 'redis'): 16 | g.redis = Redis(host="redis", db=0, socket_timeout=5) 17 | return g.redis 18 | 19 | @app.route("/", methods=['POST','GET']) 20 | def hello(): 21 | voter_id = request.cookies.get('voter_id') 22 | if not voter_id: 23 | voter_id = hex(random.getrandbits(64))[2:-1] 24 | 25 | vote = None 26 | 27 | if request.method == 'POST': 28 | redis = get_redis() 29 | vote = request.form['vote'] 30 | data = json.dumps({'voter_id': voter_id, 'vote': vote}) 31 | redis.rpush('votes', data) 32 | 33 | resp = make_response(render_template( 34 | 'index.html', 35 | option_a=option_a, 36 | option_b=option_b, 37 | hostname=hostname, 38 | vote=vote, 39 | )) 40 | resp.set_cookie('voter_id', voter_id) 41 | return resp 42 | 43 | 44 | if __name__ == "__main__": 45 | app.run(host='0.0.0.0', port=80, debug=True, threaded=True) 46 | -------------------------------------------------------------------------------- /example-voting-app/vote/app.py: -------------------------------------------------------------------------------- 1 | from flask import Flask, render_template, request, make_response, g 2 | from redis import Redis 3 | import os 4 | import socket 5 | import random 6 | import json 7 | 8 | option_a = os.getenv('OPTION_A', "Cats") 9 | option_b = os.getenv('OPTION_B', "Dogs") 10 | hostname = socket.gethostname() 11 | 12 | app = Flask(__name__) 13 | 14 | def get_redis(): 15 | if not hasattr(g, 'redis'): 16 | g.redis = Redis(host="redis", db=0, socket_timeout=5) 17 | return g.redis 18 | 19 | @app.route("/", methods=['POST','GET']) 20 | def hello(): 21 | voter_id = request.cookies.get('voter_id') 22 | if not voter_id: 23 | voter_id = hex(random.getrandbits(64))[2:-1] 24 | 25 | vote = None 26 | 27 | if request.method == 'POST': 28 | redis = get_redis() 29 | vote = request.form['vote'] 30 | data = json.dumps({'voter_id': voter_id, 'vote': vote}) 31 | redis.rpush('votes', data) 32 | 33 | resp = make_response(render_template( 34 | 'index.html', 35 | option_a=option_a, 36 | option_b=option_b, 37 | hostname=hostname, 38 | vote=vote, 39 | )) 40 | resp.set_cookie('voter_id', voter_id) 41 | return resp 42 | 43 | 44 | if __name__ == "__main__": 45 | app.run(host='0.0.0.0', port=80, debug=True, threaded=True) 46 | -------------------------------------------------------------------------------- /example-voting-app/result/views/app.js: -------------------------------------------------------------------------------- 1 | var app = angular.module('catsvsdogs', []); 2 | var socket = io.connect({transports:['polling']}); 3 | 4 | var bg1 = document.getElementById('background-stats-1'); 5 | var bg2 = document.getElementById('background-stats-2'); 6 | 7 | app.controller('statsCtrl', function($scope){ 8 | $scope.aPercent = 50; 9 | $scope.bPercent = 50; 10 | 11 | var updateScores = function(){ 12 | socket.on('scores', function (json) { 13 | data = JSON.parse(json); 14 | var a = parseInt(data.a || 0); 15 | var b = parseInt(data.b || 0); 16 | 17 | var percentages = getPercentages(a, b); 18 | 19 | bg1.style.width = percentages.a + "%"; 20 | bg2.style.width = percentages.b + "%"; 21 | 22 | $scope.$apply(function () { 23 | $scope.aPercent = percentages.a; 24 | $scope.bPercent = percentages.b; 25 | $scope.total = a + b; 26 | }); 27 | }); 28 | }; 29 | 30 | var init = function(){ 31 | document.body.style.opacity=1; 32 | updateScores(); 33 | }; 34 | socket.on('message',function(data){ 35 | init(); 36 | }); 37 | }); 38 | 39 | function getPercentages(a, b) { 40 | var result = {}; 41 | 42 | if (a + b > 0) { 43 | result.a = Math.round(a / (a + b) * 100); 44 | result.b = 100 - result.a; 45 | } else { 46 | result.a = result.b = 50; 47 | } 48 | 49 | return result; 50 | } -------------------------------------------------------------------------------- /serverless-docker-voting-app/result/public/app.js: -------------------------------------------------------------------------------- 1 | var app = angular.module('catsvsdogs', []); 2 | // var socket = io.connect({transports:['polling']}); 3 | 4 | var bg1 = document.getElementById('background-stats-1'); 5 | var bg2 = document.getElementById('background-stats-2'); 6 | 7 | app.controller('statsCtrl', function($scope, $http, $timeout){ 8 | var animateStats = function(a,b){ 9 | if(a+b>0){ 10 | var percentA = a/(a+b)*100; 11 | var percentB = 100-percentA; 12 | bg1.style.width= percentA+"%"; 13 | bg2.style.width = percentB+"%"; 14 | } 15 | }; 16 | 17 | $scope.aPercent = 50; 18 | $scope.bPercent = 50; 19 | 20 | var updateScores = function(data){ 21 | var a = parseInt(data.a || 0); 22 | var b = parseInt(data.b || 0); 23 | 24 | animateStats(a, b); 25 | 26 | if(a + b > 0){ 27 | $scope.aPercent = a/(a+b) * 100; 28 | $scope.bPercent = b/(a+b) * 100; 29 | $scope.total = a + b; 30 | } 31 | }; 32 | 33 | var getScores = function() { 34 | $http({ 35 | method: 'GET', 36 | url: '/result/votes' 37 | }).then(function successCallback(response) { 38 | updateScores(response.data); 39 | }, function errorCallback(response) { 40 | console.log(response); 41 | }); 42 | 43 | $timeout(getScores, 2000); 44 | }; 45 | 46 | var init = function(){ 47 | document.body.style.opacity=1; 48 | getScores(); 49 | }; 50 | init(); 51 | }); 52 | -------------------------------------------------------------------------------- /example-voting-app/result/views/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Cats vs Dogs -- Result 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 |
14 |
15 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
Cats
24 |
{{aPercent | number:1}}%
25 |
26 |
27 |
28 |
Dogs
29 |
{{bPercent | number:1}}%
30 |
31 |
32 |
33 |
34 |
35 | No votes yet 36 | {{total}} vote 37 | {{total}} votes 38 |
39 | 40 | 41 | 42 | 43 | 44 | -------------------------------------------------------------------------------- /circleci/templates/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | {{option_a}} vs {{option_b}}! 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 |
15 |
16 |

{{option_a}} vs {{option_b}}!

17 |
18 | 19 | 20 |
21 |
22 | (Tip: you can change your vote) 23 |
24 |
25 | Processed by container ID {{hostname}} 26 |
27 |
28 |
29 | 30 | 31 | 32 | {% if vote %} 33 | 47 | {% endif %} 48 | 49 | 50 | -------------------------------------------------------------------------------- /example-voting-app/vote/templates/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | {{option_a}} vs {{option_b}}! 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 |
15 |
16 |

{{option_a}} vs {{option_b}}!

17 |
18 | 19 | 20 |
21 |
22 | (Tip: you can change your vote) 23 |
24 |
25 | Processed by container ID {{hostname}} 26 |
27 |
28 |
29 | 30 | 31 | 32 | {% if vote %} 33 | 47 | {% endif %} 48 | 49 | 50 | -------------------------------------------------------------------------------- /serverless-docker-voting-app/record-vote-task/src/main/java/worker/Worker.java: -------------------------------------------------------------------------------- 1 | package worker; 2 | 3 | import java.sql.*; 4 | 5 | class Worker { 6 | public static void main(String[] args) { 7 | try { 8 | Connection dbConn = connectToDB("db"); 9 | 10 | String voterID = args[0]; 11 | String vote = args[1]; 12 | 13 | System.err.printf("Processing vote for '%s' by '%s'\n", vote, voterID); 14 | updateVote(dbConn, voterID, vote); 15 | } catch (SQLException e) { 16 | e.printStackTrace(); 17 | System.exit(1); 18 | } 19 | } 20 | 21 | static void updateVote(Connection dbConn, String voterID, String vote) throws SQLException { 22 | PreparedStatement insert = dbConn.prepareStatement( 23 | "INSERT INTO votes (id, vote) VALUES (?, ?)"); 24 | insert.setString(1, voterID); 25 | insert.setString(2, vote); 26 | 27 | try { 28 | insert.executeUpdate(); 29 | } catch (SQLException e) { 30 | PreparedStatement update = dbConn.prepareStatement( 31 | "UPDATE votes SET vote = ? WHERE id = ?"); 32 | update.setString(1, vote); 33 | update.setString(2, voterID); 34 | update.executeUpdate(); 35 | } 36 | } 37 | 38 | static Connection connectToDB(String host) throws SQLException { 39 | Connection conn = null; 40 | 41 | try { 42 | 43 | Class.forName("org.postgresql.Driver"); 44 | String url = "jdbc:postgresql://" + host + "/postgres"; 45 | 46 | while (conn == null) { 47 | try { 48 | conn = DriverManager.getConnection(url, "postgres", ""); 49 | } catch (SQLException e) { 50 | System.err.println("Failed to connect to db - retrying"); 51 | sleep(1000); 52 | } 53 | } 54 | 55 | PreparedStatement st = conn.prepareStatement( 56 | "CREATE TABLE IF NOT EXISTS votes (id VARCHAR(255) NOT NULL UNIQUE, vote VARCHAR(255) NOT NULL)"); 57 | st.executeUpdate(); 58 | 59 | } catch (ClassNotFoundException e) { 60 | e.printStackTrace(); 61 | System.exit(1); 62 | } 63 | 64 | return conn; 65 | } 66 | 67 | static void sleep(long duration) { 68 | try { 69 | Thread.sleep(duration); 70 | } catch (InterruptedException e) { 71 | System.exit(1); 72 | } 73 | } 74 | } 75 | -------------------------------------------------------------------------------- /example-voting-app/result/views/stylesheets/style.css: -------------------------------------------------------------------------------- 1 | @import url(//fonts.googleapis.com/css?family=Open+Sans:400,700,600); 2 | 3 | *{ 4 | box-sizing:border-box; 5 | } 6 | html,body{ 7 | margin:0; 8 | padding:0; 9 | height:100%; 10 | font-family: 'Open Sans'; 11 | } 12 | body{ 13 | opacity:0; 14 | transition: all 1s linear; 15 | } 16 | 17 | .divider{ 18 | height: 150px; 19 | width:2px; 20 | background-color: #C0C9CE; 21 | position: relative; 22 | top: 50%; 23 | float: left; 24 | transform: translateY(-50%); 25 | } 26 | 27 | #background-stats-1{ 28 | background-color: #2196f3; 29 | } 30 | 31 | #background-stats-2{ 32 | background-color: #00cbca; 33 | } 34 | 35 | #content-container{ 36 | z-index:2; 37 | position:relative; 38 | margin:0 auto; 39 | display:table; 40 | padding:10px; 41 | max-width:940px; 42 | height:100%; 43 | } 44 | #content-container-center{ 45 | display:table-cell; 46 | text-align:center; 47 | vertical-align:middle; 48 | } 49 | #result{ 50 | z-index: 3; 51 | position: absolute; 52 | bottom: 40px; 53 | right: 20px; 54 | color: #fff; 55 | opacity: 0.5; 56 | font-size: 45px; 57 | font-weight: 600; 58 | } 59 | #choice{ 60 | transition: all 300ms linear; 61 | line-height:1.3em; 62 | background:#fff; 63 | box-shadow: 10px 0 0 #fff, -10px 0 0 #fff; 64 | vertical-align:middle; 65 | font-size:40px; 66 | font-weight: 600; 67 | width: 450px; 68 | height: 200px; 69 | } 70 | #choice a{ 71 | text-decoration:none; 72 | } 73 | #choice a:hover, #choice a:focus{ 74 | outline:0; 75 | text-decoration:underline; 76 | } 77 | 78 | #choice .choice{ 79 | width: 49%; 80 | position: relative; 81 | top: 50%; 82 | transform: translateY(-50%); 83 | text-align: left; 84 | padding-left: 50px; 85 | } 86 | 87 | #choice .choice .label{ 88 | text-transform: uppercase; 89 | } 90 | 91 | #choice .choice.dogs{ 92 | color: #00cbca; 93 | float: right; 94 | } 95 | 96 | #choice .choice.cats{ 97 | color: #2196f3; 98 | float: left; 99 | } 100 | #background-stats{ 101 | z-index:1; 102 | height:100%; 103 | width:100%; 104 | position:absolute; 105 | } 106 | #background-stats div{ 107 | transition: width 400ms ease-in-out; 108 | display:inline-block; 109 | margin-bottom:-4px; 110 | width:50%; 111 | height:100%; 112 | } 113 | -------------------------------------------------------------------------------- /serverless-docker-voting-app/README_CH.md: -------------------------------------------------------------------------------- 1 | #Serverless 架構 & Docker 2 | 目前服務於 Docker 公司的 Ben Firshman 於 DockerCon 2016 Hackathon 之作品 3 | 4 | 原 fig 作者(被 Docker 併購,後來變成 Docker Compose) - Ben Firshman ,在 DockerCon 2016 Hackathon 分享他個人的小作品,[相關內容](https://github.com/bfirsh/serverless-docker),[無伺服器架構](https://read01.com/RRQMLQ.html),其中 [Docker 官方部落格](https://blog.docker.com/2016/06/building-serverless-apps-with-docker/)有解說整個實作內容,[簡體翻譯](https://linux.cn/article-7525-1.html)。是將第一個課程官方 Web 投票微服務範例改寫成 serverless 。 5 | 6 | #準備環境 7 | ##Install Docker Compose 1.8.0 8 | **請注意**,Docker Composer V2 需要配合 **Docker 1.10** 之後版本, 9 | 依照 [Compose 文件](https://github.com/docker/compose/releases),執行 ```curl -L https://github.com/docker/compose/releases/download/1.8.0/docker-compose-`uname -s`-`uname -m` > ./docker-compose```{{execute}} 10 | 和 `chmod +x ./docker-compose && sudo mv ./docker-compose /usr/local/bin/docker-compose`{{execute}} 11 | ,完成 docker-compose 安裝,確認版本 `docker-compose -v`{{execute}} 。 12 | 13 | ##Install Docker 1.12 14 | 執行 `sudo apt-get -y update`{{execute}} 15 | 更新套件,接著安裝新版 Docker, `sudo apt-get install -y docker-engine`{{execute}} 16 | ,選擇保留原本設定,按 `N`{{execute}} ,完成後,執行 `docker -v` 確認版本。 17 | 18 | ##複製範例程式庫 19 | 從 Github 複製 Docker 無伺服器範例,執行 `git clone https://github.com/bfirsh/serverless-docker-voting-app`{{execute}}。 20 | 21 | ##啟動範例 22 | 切換到範例目錄, `cd serverless-docker-voting-app`{{execute}}, 23 | 接著需輸入 `docker-compose -f docker-compose.build.yml build && docker-compose build && docker pull postgres:9.4`{{execute}},即開始建置。 24 | 25 | #啟動無伺服器範例 26 | ##耐心等待是必要的 T_T 27 | ![Pokemon Go BEN Screen](https://cloud.githubusercontent.com/assets/664465/17803186/6b435504-6627-11e6-8694-4291bafb03c3.PNG) 28 | 29 | ##啟動範例 30 | Build 好映像檔,就執行 `docker-compose up -d`{{execute}}。 31 | 32 | ![shia-labeouf-magic](https://cloud.githubusercontent.com/assets/664465/17802850/3e967362-6625-11e6-9214-703da1bc1826.gif) 33 | 34 | 請點選上方的 + 符號,選擇「Web Preview host port 80」,網址後加上 **vote/** 可看到投票畫面,加上 **result/** 可看到結果畫面。 35 | 36 | 輸入 `docker ps`{{execute}} 查看運作過程。 37 | 38 | #SUMMARY 39 | [AWS Lambda](http://www.ithome.com.tw/news/93920)服務的推出,進化到無需自行管理維護伺服器,並在流量大時自動擴展規模,而[淺析 serverless 架構與實作](http://abalone0204.github.io/2016/05/22/serverless-simple-crud/)文章有更深入介紹,近期更有針對此架構所發展的 [Serverless Framework](http://serverless.com/ 40 | )。 41 | 延伸閱讀: 42 | [Martin Fowler - Serverless](http://martinfowler.com/bliki/Serverless.html) 43 | [Martin Fowler - Serverless Architectures](http://martinfowler.com/articles/serverless.html) 44 | -------------------------------------------------------------------------------- /example-voting-app/result/server.js: -------------------------------------------------------------------------------- 1 | var express = require('express'), 2 | async = require('async'), 3 | pg = require("pg"), 4 | cookieParser = require('cookie-parser'), 5 | bodyParser = require('body-parser'), 6 | methodOverride = require('method-override'), 7 | app = express(), 8 | server = require('http').Server(app), 9 | io = require('socket.io')(server); 10 | 11 | io.set('transports', ['polling']); 12 | 13 | var port = process.env.PORT || 4000; 14 | 15 | io.sockets.on('connection', function (socket) { 16 | 17 | socket.emit('message', { text : 'Welcome!' }); 18 | 19 | socket.on('subscribe', function (data) { 20 | socket.join(data.channel); 21 | }); 22 | }); 23 | 24 | async.retry( 25 | {times: 1000, interval: 1000}, 26 | function(callback) { 27 | pg.connect('postgres://postgres@db/postgres', function(err, client, done) { 28 | if (err) { 29 | console.error("Waiting for db"); 30 | } 31 | callback(err, client); 32 | }); 33 | }, 34 | function(err, client) { 35 | if (err) { 36 | return console.err("Giving up"); 37 | } 38 | console.log("Connected to db"); 39 | getVotes(client); 40 | } 41 | ); 42 | 43 | function getVotes(client) { 44 | client.query('SELECT vote, COUNT(id) AS count FROM votes GROUP BY vote', [], function(err, result) { 45 | if (err) { 46 | console.error("Error performing query: " + err); 47 | } else { 48 | var votes = collectVotesFromResult(result); 49 | io.sockets.emit("scores", JSON.stringify(votes)); 50 | } 51 | 52 | setTimeout(function() {getVotes(client) }, 1000); 53 | }); 54 | } 55 | 56 | function collectVotesFromResult(result) { 57 | var votes = {a: 0, b: 0}; 58 | 59 | result.rows.forEach(function (row) { 60 | votes[row.vote] = parseInt(row.count); 61 | }); 62 | 63 | return votes; 64 | } 65 | 66 | app.use(cookieParser()); 67 | app.use(bodyParser()); 68 | app.use(methodOverride('X-HTTP-Method-Override')); 69 | app.use(function(req, res, next) { 70 | res.header("Access-Control-Allow-Origin", "*"); 71 | res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept"); 72 | res.header("Access-Control-Allow-Methods", "PUT, GET, POST, DELETE, OPTIONS"); 73 | next(); 74 | }); 75 | 76 | app.use(express.static(__dirname + '/views')); 77 | 78 | app.get('/', function (req, res) { 79 | res.sendFile(path.resolve(__dirname + '/views/index.html')); 80 | }); 81 | 82 | server.listen(port, function () { 83 | var port = server.address().port; 84 | console.log('App running on port ' + port); 85 | }); 86 | -------------------------------------------------------------------------------- /circleci/static/stylesheets/style.css: -------------------------------------------------------------------------------- 1 | @import url(//fonts.googleapis.com/css?family=Open+Sans:400,700,600); 2 | 3 | *{ 4 | box-sizing:border-box; 5 | } 6 | html,body{ 7 | margin: 0; 8 | padding: 0; 9 | background-color: #F7F8F9; 10 | height: 100vh; 11 | font-family: 'Open Sans'; 12 | } 13 | 14 | button{ 15 | border-radius: 0; 16 | width: 100%; 17 | height: 50%; 18 | } 19 | 20 | button[type="submit"] { 21 | -webkit-appearance:none; -webkit-border-radius:0; 22 | } 23 | 24 | button i{ 25 | float: right; 26 | padding-right: 30px; 27 | margin-top: 3px; 28 | } 29 | 30 | button.a{ 31 | background-color: #1aaaf8; 32 | } 33 | 34 | button.b{ 35 | background-color: #00cbca; 36 | } 37 | 38 | #tip{ 39 | text-align: left; 40 | color: #c0c9ce; 41 | font-size: 14px; 42 | } 43 | 44 | #hostname{ 45 | position: absolute; 46 | bottom: 100px; 47 | right: 0; 48 | left: 0; 49 | color: #8f9ea8; 50 | font-size: 24px; 51 | } 52 | 53 | #content-container{ 54 | z-index: 2; 55 | position: relative; 56 | margin: 0 auto; 57 | display: table; 58 | padding: 10px; 59 | max-width: 940px; 60 | height: 100%; 61 | } 62 | #content-container-center{ 63 | display: table-cell; 64 | text-align: center; 65 | } 66 | 67 | #content-container-center h3{ 68 | color: #254356; 69 | } 70 | 71 | #choice{ 72 | transition: all 300ms linear; 73 | line-height: 1.3em; 74 | display: inline; 75 | vertical-align: middle; 76 | font-size: 3em; 77 | } 78 | #choice a{ 79 | text-decoration:none; 80 | } 81 | #choice a:hover, #choice a:focus{ 82 | outline:0; 83 | text-decoration:underline; 84 | } 85 | 86 | #choice button{ 87 | display: block; 88 | height: 80px; 89 | width: 330px; 90 | border: none; 91 | color: white; 92 | text-transform: uppercase; 93 | font-size:18px; 94 | font-weight: 700; 95 | margin-top: 10px; 96 | margin-bottom: 10px; 97 | text-align: left; 98 | padding-left: 50px; 99 | } 100 | 101 | #choice button.a:hover{ 102 | background-color: #1488c6; 103 | } 104 | 105 | #choice button.b:hover{ 106 | background-color: #00a2a1; 107 | } 108 | 109 | #choice button.a:focus{ 110 | background-color: #1488c6; 111 | } 112 | 113 | #choice button.b:focus{ 114 | background-color: #00a2a1; 115 | } 116 | 117 | #background-stats{ 118 | z-index:1; 119 | height:100%; 120 | width:100%; 121 | position:absolute; 122 | } 123 | #background-stats div{ 124 | transition: width 400ms ease-in-out; 125 | display:inline-block; 126 | margin-bottom:-4px; 127 | width:50%; 128 | height:100%; 129 | } 130 | -------------------------------------------------------------------------------- /serverless-docker-voting-app/record-vote-task/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | worker 7 | worker 8 | 1.0-SNAPSHOT 9 | 10 | 11 | 12 | 13 | org.json 14 | json 15 | 20240303 16 | 17 | 18 | 19 | org.postgresql 20 | postgresql 21 | 42.7.1 22 | 23 | 24 | 25 | 26 | 27 | 28 | org.apache.maven.plugins 29 | maven-jar-plugin 30 | 3.3.0 31 | 32 | worker 33 | 34 | 35 | true 36 | worker.Worker 37 | dependency-jars/ 38 | 39 | 40 | 41 | 42 | 43 | org.apache.maven.plugins 44 | maven-compiler-plugin 45 | 3.12.1 46 | 47 | 1.8 48 | 1.8 49 | 50 | 51 | 52 | org.apache.maven.plugins 53 | maven-assembly-plugin 54 | 55 | 56 | 57 | attached 58 | 59 | package 60 | 61 | worker 62 | 63 | jar-with-dependencies 64 | 65 | 66 | 67 | worker.Worker 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | -------------------------------------------------------------------------------- /example-voting-app/vote/static/stylesheets/style.css: -------------------------------------------------------------------------------- 1 | @import url(//fonts.googleapis.com/css?family=Open+Sans:400,700,600); 2 | 3 | *{ 4 | box-sizing:border-box; 5 | } 6 | html,body{ 7 | margin: 0; 8 | padding: 0; 9 | background-color: #F7F8F9; 10 | height: 100vh; 11 | font-family: 'Open Sans'; 12 | } 13 | 14 | button{ 15 | border-radius: 0; 16 | width: 100%; 17 | height: 50%; 18 | } 19 | 20 | button[type="submit"] { 21 | -webkit-appearance:none; -webkit-border-radius:0; 22 | } 23 | 24 | button i{ 25 | float: right; 26 | padding-right: 30px; 27 | margin-top: 3px; 28 | } 29 | 30 | button.a{ 31 | background-color: #1aaaf8; 32 | } 33 | 34 | button.b{ 35 | background-color: #00cbca; 36 | } 37 | 38 | #tip{ 39 | text-align: left; 40 | color: #c0c9ce; 41 | font-size: 14px; 42 | } 43 | 44 | #hostname{ 45 | position: absolute; 46 | bottom: 100px; 47 | right: 0; 48 | left: 0; 49 | color: #8f9ea8; 50 | font-size: 24px; 51 | } 52 | 53 | #content-container{ 54 | z-index: 2; 55 | position: relative; 56 | margin: 0 auto; 57 | display: table; 58 | padding: 10px; 59 | max-width: 940px; 60 | height: 100%; 61 | } 62 | #content-container-center{ 63 | display: table-cell; 64 | text-align: center; 65 | } 66 | 67 | #content-container-center h3{ 68 | color: #254356; 69 | } 70 | 71 | #choice{ 72 | transition: all 300ms linear; 73 | line-height: 1.3em; 74 | display: inline; 75 | vertical-align: middle; 76 | font-size: 3em; 77 | } 78 | #choice a{ 79 | text-decoration:none; 80 | } 81 | #choice a:hover, #choice a:focus{ 82 | outline:0; 83 | text-decoration:underline; 84 | } 85 | 86 | #choice button{ 87 | display: block; 88 | height: 80px; 89 | width: 330px; 90 | border: none; 91 | color: white; 92 | text-transform: uppercase; 93 | font-size:18px; 94 | font-weight: 700; 95 | margin-top: 10px; 96 | margin-bottom: 10px; 97 | text-align: left; 98 | padding-left: 50px; 99 | } 100 | 101 | #choice button.a:hover{ 102 | background-color: #1488c6; 103 | } 104 | 105 | #choice button.b:hover{ 106 | background-color: #00a2a1; 107 | } 108 | 109 | #choice button.a:focus{ 110 | background-color: #1488c6; 111 | } 112 | 113 | #choice button.b:focus{ 114 | background-color: #00a2a1; 115 | } 116 | 117 | #background-stats{ 118 | z-index:1; 119 | height:100%; 120 | width:100%; 121 | position:absolute; 122 | } 123 | #background-stats div{ 124 | transition: width 400ms ease-in-out; 125 | display:inline-block; 126 | margin-bottom:-4px; 127 | width:50%; 128 | height:100%; 129 | } 130 | -------------------------------------------------------------------------------- /example-voting-app/worker/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | worker 7 | worker 8 | 1.0-SNAPSHOT 9 | 10 | 11 | 12 | 13 | org.json 14 | json 15 | 20240303 16 | 17 | 18 | 19 | redis.clients 20 | jedis 21 | 5.1.0 22 | jar 23 | compile 24 | 25 | 26 | 27 | org.postgresql 28 | postgresql 29 | 42.7.1 30 | 31 | 32 | 33 | 34 | 35 | 36 | org.apache.maven.plugins 37 | maven-jar-plugin 38 | 3.3.0 39 | 40 | worker 41 | 42 | 43 | true 44 | worker.Worker 45 | dependency-jars/ 46 | 47 | 48 | 49 | 50 | 51 | org.apache.maven.plugins 52 | maven-compiler-plugin 53 | 3.12.1 54 | 55 | 1.8 56 | 1.8 57 | 58 | 59 | 60 | org.apache.maven.plugins 61 | maven-assembly-plugin 62 | 63 | 64 | 65 | attached 66 | 67 | package 68 | 69 | worker 70 | 71 | jar-with-dependencies 72 | 73 | 74 | 75 | worker.Worker 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | -------------------------------------------------------------------------------- /example-voting-app/worker/src/main/java/worker/Worker.java: -------------------------------------------------------------------------------- 1 | package worker; 2 | 3 | import redis.clients.jedis.Jedis; 4 | import redis.clients.jedis.exceptions.JedisConnectionException; 5 | import java.sql.*; 6 | import org.json.JSONObject; 7 | 8 | class Worker { 9 | public static void main(String[] args) { 10 | try { 11 | Jedis redis = connectToRedis("redis"); 12 | Connection dbConn = connectToDB("db"); 13 | 14 | System.err.println("Watching vote queue"); 15 | 16 | while (true) { 17 | String voteJSON = redis.blpop(0, "votes").get(1); 18 | JSONObject voteData = new JSONObject(voteJSON); 19 | String voterID = voteData.getString("voter_id"); 20 | String vote = voteData.getString("vote"); 21 | 22 | System.err.printf("Processing vote for '%s' by '%s'\n", vote, voterID); 23 | updateVote(dbConn, voterID, vote); 24 | } 25 | } catch (SQLException e) { 26 | e.printStackTrace(); 27 | System.exit(1); 28 | } 29 | } 30 | 31 | static void updateVote(Connection dbConn, String voterID, String vote) throws SQLException { 32 | PreparedStatement insert = dbConn.prepareStatement( 33 | "INSERT INTO votes (id, vote) VALUES (?, ?)"); 34 | insert.setString(1, voterID); 35 | insert.setString(2, vote); 36 | 37 | try { 38 | insert.executeUpdate(); 39 | } catch (SQLException e) { 40 | PreparedStatement update = dbConn.prepareStatement( 41 | "UPDATE votes SET vote = ? WHERE id = ?"); 42 | update.setString(1, vote); 43 | update.setString(2, voterID); 44 | update.executeUpdate(); 45 | } 46 | } 47 | 48 | static Jedis connectToRedis(String host) { 49 | Jedis conn = new Jedis(host); 50 | 51 | while (true) { 52 | try { 53 | conn.keys("*"); 54 | break; 55 | } catch (JedisConnectionException e) { 56 | System.err.println("Failed to connect to redis - retrying"); 57 | sleep(1000); 58 | } 59 | } 60 | 61 | System.err.println("Connected to redis"); 62 | return conn; 63 | } 64 | 65 | static Connection connectToDB(String host) throws SQLException { 66 | Connection conn = null; 67 | 68 | try { 69 | 70 | Class.forName("org.postgresql.Driver"); 71 | String url = "jdbc:postgresql://" + host + "/postgres"; 72 | 73 | while (conn == null) { 74 | try { 75 | conn = DriverManager.getConnection(url, "postgres", ""); 76 | } catch (SQLException e) { 77 | System.err.println("Failed to connect to db - retrying"); 78 | sleep(1000); 79 | } 80 | } 81 | 82 | PreparedStatement st = conn.prepareStatement( 83 | "CREATE TABLE IF NOT EXISTS votes (id VARCHAR(255) NOT NULL UNIQUE, vote VARCHAR(255) NOT NULL)"); 84 | st.executeUpdate(); 85 | 86 | } catch (ClassNotFoundException e) { 87 | e.printStackTrace(); 88 | System.exit(1); 89 | } 90 | 91 | return conn; 92 | } 93 | 94 | static void sleep(long duration) { 95 | try { 96 | Thread.sleep(duration); 97 | } catch (InterruptedException e) { 98 | System.exit(1); 99 | } 100 | } 101 | } 102 | -------------------------------------------------------------------------------- /minimal_nodejs/README.md: -------------------------------------------------------------------------------- 1 | #Minimal Node.js Docker Image 2 | ##Use Enclose to compile the binary execute file. 3 | 在這個實驗中,了解 Docker 映像檔的建立,及其檔案系統。 4 | ##scratch 5 | **[scratch](https://hub.docker.com/_/scratch/)** 是 Docker 映像檔之母,所有基礎映像檔(Base Image)都是由 scratch 所建置而成。它其實是一個空的映像檔,把所需要的環境將其檔案系統匯入到其中,使得依賴這樣檔案系統的程式可以正確運作。 6 | ##相關文件 7 | 1. [Create a base image](https://docs.docker.com/engine/userguide/eng-image/baseimages/) 8 | 2. [從映像檔產生 Dockerfile](https://philipzheng.gitbooks.io/docker_practice/content/dockerfile/file_from_image.html) 9 | 10 | #Just do "make" 11 | ##複製範例程式 12 | `git clone https://github.com/philipz/node_minimal`{{execute}} 13 | ##安裝 Make 套件 14 | `sudo apt-get install make `{{execute}} 15 | ##開始建置 16 | 先 `cd node_minimal`{{execute}} , 17 | 接著只需要 `make`{{execute}} , 18 | 執行完後查看是否有建置好的 Docker 映像檔 `docker images`{{execute}} ,這樣就建置好最小 Node.js 應用程式的 Docker 映像檔。 19 | ##確認 20 | 執行這最小 Node.js 應用程式的 Docker 映像檔, `docker run -d -p 80:8000 philipz/minimal`{{execute}} ,啟動後,請點選上方的 **+** 符號,選擇「Web Preview host port 80」,就可看到執行結果。 21 | 22 | 透過 `docker inspect philipz/minimal | more`{{execute}} 可以查看這映像檔的詳細資訊。 23 | 24 | #How it works? Makefile 25 | 就來逐一解說,整個建置過程的每一個環節。 26 | ## Makefile 27 | 首先是利用 **GNU Make** 來執行定義好的 *Makefile* ,其中 *Makefile* 內容如下: 28 | ``` 29 | NAME = minimal 30 | APP_NAME = index.js 31 | NODE_VERSION = 6.0.0 32 | 33 | PWD := $(shell pwd) 34 | 35 | .PHONY: all 36 | 37 | all: clean build 38 | 39 | build: 40 | docker run -ti --rm -v $(PWD):/app node:$(NODE_VERSION) /app/compile.sh $(APP_NAME) $(NAME) 41 | echo 'FROM scratch\nADD build.tar.gz /\nCMD ["/app/$(NAME)"]' > Dockerfile 42 | docker build -t philipz/$(NAME) . 43 | 44 | clean: clean-exe clean-build 45 | 46 | clean-docker: 47 | docker rmi philipz/$(NAME) 48 | clean-exe: 49 | sudo rm -f $(NAME) 50 | clean-build: 51 | sudo rm -rf build 52 | sudo rm -f build.tar.gz 53 | ``` 54 | 55 | 前面三行定義變數,可依需求修改, *NAME* 是這程式名稱,也是編譯出來的執行檔名稱,而 *APP_NAME* 是 Node.js 主程式名稱,*NODE_VERSION* 則是欲使用的 Node.js 版本,根據這版號當作 Docker 標籤(tag)來建置其映像檔。 56 | 57 | 最主要是 `docker run -ti --rm -v $(PWD):/app node:$(NODE_VERSION) /app/compile.sh $(APP_NAME) $(NAME)` ,啟動官方 node 映像檔,並掛載目前所在目錄到容器的 */app* 目錄,再執行 *compile.sh* 這 bash script 程式。下一步驟便介紹 *compile.sh* 的內容。 58 | 59 | #How it works? compile.sh 60 | ## compile.sh 61 | 而 *compile.sh* script 程式,內容如下: 62 | ``` 63 | #!/bin/bash 64 | cd /app 65 | npm install 66 | npm install -g enclose 67 | enclose --loglevel info -o ./$2 ./$1 68 | ./copy_ldd.sh $2 build 69 | cd build && tar zcf build.tar.gz * && mv build.tar.gz ../ && cd /app && rm -rf build 70 | exit 71 | ``` 72 | 73 | 單純只是執行 npm 及 [enclose](http://enclosejs.com/) 這套專門用來將 Node.js 編譯成執行檔的工具。 `npm install -g enclose ` 安裝好 enclose ,便用它來輸出成 $2 參數二, $(NAME) 執行檔,而 $1 參數一,則為 $(APP_NAME) Node.js 主程式名稱。 74 | 75 | #How it works? copy_ldd.sh 76 | ##copy_ldd.sh 77 | 再下來執行 `copy_ldd.sh` 來分析編譯好的執行檔,由於 `copy_ldd.sh` 檔案內容較長,請自行研讀,主要目的就是將編譯好的 Node.js 程式執行檔(*minimal *),用 **ldd** 指令分析其有關的函示庫,把相關函式庫,放到 build 目錄中,讓 `compile.sh` 可以壓縮打包成 tar.gz 檔案,便於讓 Dockerfile 以 `ADD` 指令建置出 Docker 映像檔。 78 | ##參考文件 79 | [Export a linux binary with its lib dependencies to a chroot or initramfs, …](http://www.metashock.de/2012/11/export-binary-with-lib-dependencies/) 80 | 81 | #SUMMARY 82 | 透過這個範例,就可理解 Docker 映像檔,其實只是一個符合程式所需的檔案系統結構,也可視為執行環境所需的檔案系統。而 Docekr 容器本身應該以單一個 **process** 來區分,而非是一整個 VM 的角度來看待容器,而這最小化的 Node.js 程式映像檔,就只是提供必要的相關函示庫(放置於所需的目錄位置)和其程式,未包含其他不必要的檔案和作業系統的指令,所以這最小化映像檔,也無法使用 `docker run -ti philipz/minimal bash`{{execute}} 登入到容器之中。 83 | 84 | 希望這個範例,能讓各位更理解容器的運作。 85 | -------------------------------------------------------------------------------- /compose_dns/README.md: -------------------------------------------------------------------------------- 1 | #Docker-Compose & Service Discovery 2 | ##透過 Docker 1.12 解釋其 Docker Network 機制和 DNS-based Service Discovery 3 | 4 | 此操作範例是介紹 Docker Compose 的使用方式及其指令,並解釋 Docker 1.12 版新增的 DNS-based Service Discovery 機制,以及 Docker Network 的 VLAN 容器隔離功能,希望能幫忙您撰寫自己的 *docker-compose.yml* 檔案,並設計所需系統架構。 5 | 6 | #準備環境 7 | ##Install Docker 1.12 8 | 執行 `sudo apt-get -y update`{{execute}} 9 | 更新套件,接著安裝新版 Docker, `sudo apt-get install -y docker-engine`{{execute}} 10 | ,選擇保留原本設定,按 `N`{{execute}} ,完成後,執行 `docker -v` 確認版本。 11 | ##Install Docker Compose 1.8.0 12 | 依照 [Compose 文件](https://github.com/docker/compose/releases),執行 ```curl -L https://github.com/docker/compose/releases/download/1.8.0/docker-compose-`uname -s`-`uname -m` > ./docker-compose```{{execute}} 13 | 和 `chmod +x ./docker-compose && sudo mv ./docker-compose /usr/local/bin/docker-compose`{{execute}} 14 | ,完成 docker-compose 安裝,一樣確認版本 `docker-compose -v`{{execute}} 。 15 | 16 | #使用 Docker Compose 17 | ##複製範例庫 18 | `git clone https://github.com/philipz/compose_dns`{{execute}} , 19 | 接著 `cd compose_dns`{{execute}} 。 20 | 21 | ##docker-compose.yml 22 | 此範例的 *docker-compose.yml* 定義檔內容如下: 23 | ``` 24 | version: '2' 25 | 26 | services: 27 | webapp: 28 | image: philipz/minimal 29 | 30 | webproxy: 31 | build: webproxy 32 | ports: 33 | - "80:80" 34 | ``` 35 | 由兩個服務所構成,*webapp* 是直接使用之前建置的 **philipz/minimal** 映像檔,而 *webproxy* 則是透過 webproxy 目錄底下的內容來建置所需映像檔。 36 | ##webproxy 37 | *webproxy* 目錄包含兩個檔案,Nginx 所需要的設定檔 *proxy.conf* 和建置映像檔的 *Dockerfile* 。其中 *proxy.conf* 設定檔內容為: 38 | ``` 39 | server { 40 | listen 80; 41 | 42 | location / { 43 | proxy_pass http://webapp:8000; 44 | } 45 | } 46 | ``` 47 | 透過 proxy_pass 功能將 HTTP request 轉送到後端的 webapp 容器的 8000 port ,單純提供 reverse proxy 功能。 48 | 49 | 而 *Dockerfile* 是以 nignx:alpine 映像檔為基礎,將上述的 *proxy.conf* 覆蓋原本的配置設定。 50 | ``` 51 | FROM nginx:alpine 52 | RUN rm /etc/nginx/conf.d/* 53 | COPY proxy.conf /etc/nginx/conf.d/ 54 | ``` 55 | 最後先建置此範例 `docker-compose build`{{execute}} 56 | ,再執行 `docker-compose up -d`{{execute}} 以背景模式運行。 57 | 58 | #Service Discovery 59 | 請點選上方的 + 符號,選擇「Web Preview host port 80」,就可看到執行結果。 60 | ##Docker Network 61 | 啟動後,我們使用 `docker-compose ps`{{execute}} 查看這容器服務的運作狀況,必須在 *docker-compose.yml* 檔案相同的目錄才能正常執行。 62 | 63 | 接下來使用 `docker network ls`{{execute}} 64 | 指令可看到 Docker Compose 為這範例建立了 *composedns_default* 這橋接器模式的虛擬網路,兩個容器服務都歸到相同的網段,若直接使用 `docker run -ti --rm nginx:alpine sh`{{execute}} 65 | 所啟動的容器,其 IP 網段將與這範例不同, `ifconfig`{{execute}}。這是 Docker 針對容器所作的網路隔離特性。 66 | ##DNS 67 | 先登出 *nginx:alpine* `exit`{{execute}} 68 | ,改進入到 *webproxy* 容器中, `docker exec -ti composedns_webproxy_1 sh`{{execute}}, 69 | 執行 `ifconfig`{{execute}} 70 | 可看出其 IP 網段就與上面容器不同,接著查看 DNS 設定, `cat /etc/resolv.conf`{{execute}} , 71 | 那 **127.0.0.11** 是 Docker 所內建的 DNS 伺服器,目的是為了服務探索所需要的容器名稱與 IP 對應,執行 `nslookup webapp`{{execute}} , 72 | 就可顯示出 webapp 容器所使用的 IP ,登出此容器 `exit`{{execute}}。 73 | 74 | 接著增加 *webapp* 容器數量到 3,`docker-compose scale webapp=3`{{execute}} , 75 | 再 `docker-compose ps`{{execute}} 76 | 查看服務的啟動情況。再登入到 *webproxy* 容器中, `docker exec -ti composedns_webproxy_1 sh`{{execute}}, 77 | 一樣輸入 `nslookup webapp`{{execute}} , 78 | 看看這次 webapp 的 DNS 名稱有何差異?可看出,這 DNS 紀錄增加到三個。執行 `nginx -s reload`{{execute}} , 79 | 重新載入主機位置,使 *webproxy* 能正確對應,此刻點選上方的 + 符號,選擇「Web Preview host port 80」,重新整理可看到每次都是不同樣的結果,是以 DNS round-robin 方式循環。而這樣的功能也具備負載平衡的好處。 80 | 81 | #Summary 82 | 利用這樣 DNS-based Service Discovery 機制,可免除掉架構上很多瑣碎的設定,直接以服務名稱就可查詢,讓 Nignx 原本 reverse proxy 功能還同時具備了 load balancing 作用。而這個操作情境,還介紹了 docker-compose 常用的指令,若需要更詳細的使用方法,建議直接使用 `docker-compose -h`{{execute}} 查詢,或閱讀 [Compose 官方文件](https://docs.docker.com/compose/)。 83 | -------------------------------------------------------------------------------- /serverless-docker-voting-app/result/public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Cats vs Dogs -- Result 6 | 7 | 8 | 9 | 122 | 123 | 124 |
125 |
126 |
128 |
129 |
130 |
131 |
132 |
133 |
134 |
Cats
135 |
{{aPercent | number:1}}%
136 |
137 |
138 |
139 |
Dogs
140 |
{{bPercent | number:1}}%
141 |
142 |
143 |
144 |
145 |
146 | {{total}} votes 147 |
148 | 149 | 150 | 151 | 152 | -------------------------------------------------------------------------------- /example-voting-app/README_CH.md: -------------------------------------------------------------------------------- 1 | #Docker 官方 Web 投票微服務範例 2 | 利用 Docker Birthday #3 所提供的範例,來說明利用 Docker 建構微服務架構系統 3 | 4 | 出處:[Wiki](https://zh.wikipedia.org/wiki/%E5%BE%AE%E6%9C%8D%E5%8B%99) 5 | 6 | 微服務 (Microservices) 是一種軟體架構風格 (Software Architecture Style),它是以專注於單一責任與功能的小型功能區塊 (Small Building Blocks) 為基礎,利用模組化的方式組合出複雜的大型應用程式,各功能區塊使用與語言無關 (Language-Independent/Language agnostic) 的 API 集相互通訊。 7 | 8 | 而 [Docker Birthday #3](https://github.com/docker/docker-birthday-3) 所提供的 Voting 範例就是以微服務方式所設計,結合 PHP、Redis、Jave、Node.js 和 Postgres ,五個單一責任的容器,組合出這一個 Web 投票系統。 9 | 10 | #投票系統架構 11 | 12 | 整個微服務架構如下: 13 | 14 | ![bd3-architecture](bd3-architecture.png) 15 | 16 | * Python Web 程式提供兩個選項來投票 17 | * Redis 佇列來收集 PHP 所選的新選票 18 | * Java worker 負責監聽 Redis 的投票佇列,再轉存到 Postgres 19 | * Postgres 資料負責持久儲存,以 Docker volume 掛載 20 | * Node.js Web 程式即時顯示所有投票結果 21 | 22 | ##Install Docker Compose 1.8.0 23 | 依照 [Compose 文件](https://github.com/docker/compose/releases),執行 ```curl -L https://github.com/docker/compose/releases/download/1.8.0/docker-compose-`uname -s`-`uname -m` > ./docker-compose```{{execute}} 24 | 和 `chmod +x ./docker-compose && sudo mv ./docker-compose /usr/local/bin/docker-compose`{{execute}} 25 | ,完成 docker-compose 安裝,一樣確認版本 `docker-compose -v`{{execute}} 。 26 | 27 | ##複製範例庫 28 | `git clone https://github.com/philipz/example-voting-app`{{execute}} 29 | 30 | #使用 Docker Compose 建置 31 | 32 | 切換到 example-voting-app 目錄,`cd example-voting-app`{{execute}} , 33 | 接著只要執行 `docker-compose up -d`{{execute}} 34 | 就完成整個投票系統建置。執行 `docker-compose ps`{{execute}} 35 | 確認整個系統狀況。 36 | 37 | 請點選上方的 + 符號,選擇「Web Preview host port 80」,就可看到投票執行網頁。再點選上方的 + 符號,選擇「Change Port」,會看到修改 Port 變更網頁,輸入 5000 ,按下 Display Port 就可看到投票網頁。畫面如下: 38 | 39 | ![change_port](https://cloud.githubusercontent.com/assets/664465/17457101/dc2b84ba-5c1f-11e6-8b50-19d5ed691dfd.png) 40 | 41 | ##解說 docker-compose.yml 42 | ``` 43 | version: "2" 44 | 45 | services: 46 | vote: 47 | build: ./vote 48 | command: python app.py 49 | volumes: 50 | - ./vote:/app 51 | ports: 52 | - "5000:80" 53 | 54 | redis: 55 | image: redis:alpine 56 | ports: ["6379"] 57 | 58 | worker: 59 | build: ./worker 60 | 61 | db: 62 | image: postgres:9.4 63 | 64 | result: 65 | build: ./result 66 | command: nodemon --debug server.js 67 | volumes: 68 | - ./result:/app 69 | ports: 70 | - "80:80" 71 | - "5858:5858" 72 | 73 | ``` 74 | 首先,宣告此 Compose 格式為 version 2 ,必須配合 Docker Engine 1.10 之後的版本使用。接下來定義如前面所描述的五個微服務元件。 75 | 1. Vote: 使用 vote 目錄來建置映像檔,其中目錄包含 Dockerfile 及其相關程式檔案。以 Python 執行 app.py,掛載 vote 到容器的 /app 目錄中,對應本機 5000 port 到容器的 80 port。 76 | 2. Redis: 直接使用 redis:alpine 映像檔,並隨機對應本機連接埠到容器 6379 port。 77 | 3. Worker: 使用 worker 目錄建置,其目錄包含 Dockerfile 、 src 目錄程式和 pom.xml 函式庫定義檔。 78 | 4. DB: 直接使用 porstgres:9.4 映像檔。 79 | 5. Result: 使用 result 目錄建置,其目錄除了 Node.js 相關程式,還包含測試程式(tests目錄),預設執行 `nodemon --debug server.js` ,並掛載 result 到容器的 /app 目錄中,對應本機 80 port 到容器的 80 port,以及 Remote debug port 5858。 80 | 81 | #改用 .NET 版的 Worker 82 | 83 | 既然是微服務架構,便可方便抽換其中一個容器服務元件,因此我們將那 **Java** 版本的 *Worker*,替換成 **.NET** 所寫的*新 Worker*,新架構如下: 84 | 85 | ![architecture](https://cloud.githubusercontent.com/assets/664465/17456546/ba03d8a4-5c0d-11e6-94a5-31f5e1432edb.png) 86 | 87 | ##改寫 docker-compose.yml 88 | 先停止之前所啟動的容器,`docker-compose down`{{execute}}, 89 | 將原本 *docker-compose.yml* 檔案中的 worker 服務,改用成 .NET 的 worker。首先將原本內容從, 90 | ``` 91 | worker: 92 | build: ./worker 93 | ``` 94 | 改成 95 | ``` 96 | worker.net: 97 | build: ./worker.net 98 | depends_on: 99 | - redis 100 | - db 101 | ``` 102 | 因 worker.net 啟動很快,若沒有加上相依容器服務,會找不到其主機位置而跳出容器,產生錯誤。 103 | 104 | 為方便操作,已修改好 *docker-compose.net.yml* 檔案,查看其內容,`cat docker-compose.net.yml`{{execute}} , 105 | 為了讓此範例運作更順利,就直接使用建置好的映象檔 **philipz/worker.net**,若想了解 .NET Worker 建置內容,可自行在電腦上重新建置,*docker-compose build*。我們直接覆蓋原本檔案,執行 `mv docker-compose.net.yml docker-compose.yml`{{execute}} , 106 | 再次執行 `docker-compose up -d`{{execute}} 107 | 就完成整個投票系統的替換建置。 108 | 109 | 再次點選上方的 + 符號,選擇「Web Preview host port 80」,就可看到投票執行網頁。再點選上方的 + 符號,選擇「Change Port」,會看到修改 Port 變更網頁,輸入 5000 ,按下 Display Port 就可看到投票網頁。執行 `docker-compose ps`{{execute}} 110 | 確認整個系統狀況。 111 | 112 | #SUMMARY 113 | 114 | 本範例,示範了 Docker Compose 相關功能及操作,並且利用 Docker Birthday #3 所提供的範例,來說明如何利用 Docker 建構微服務架構系統,並且很方便就可替換架構中的容器服務元件,讓整個架構可以隨著組織業務成長來擴展,可以隨著技術演化來替換堆疊,靈活彈性的架構可應付不斷改變的需求和變化。 115 | -------------------------------------------------------------------------------- /example-voting-app/worker.net/src/Worker/Program.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Data.Common; 3 | using System.Linq; 4 | using System.Net; 5 | using System.Net.Sockets; 6 | using System.Threading; 7 | using Newtonsoft.Json; 8 | using Npgsql; 9 | using StackExchange.Redis; 10 | 11 | namespace Worker 12 | { 13 | public class Program 14 | { 15 | public static int Main(string[] args) 16 | { 17 | try 18 | { 19 | var pgsql = OpenDbConnection("Server=db;Username=postgres;"); 20 | var redis = OpenRedisConnection("redis").GetDatabase(); 21 | 22 | var definition = new { vote = "", voter_id = "" }; 23 | while (true) 24 | { 25 | string json = redis.ListLeftPopAsync("votes").Result; 26 | if (json != null) 27 | { 28 | var vote = JsonConvert.DeserializeAnonymousType(json, definition); 29 | Console.WriteLine($"Processing vote for '{vote.vote}' by '{vote.voter_id}'"); 30 | UpdateVote(pgsql, vote.voter_id, vote.vote); 31 | } 32 | } 33 | } 34 | catch (Exception ex) 35 | { 36 | Console.Error.WriteLine(ex.ToString()); 37 | return 1; 38 | } 39 | } 40 | 41 | private static NpgsqlConnection OpenDbConnection(string connectionString) 42 | { 43 | NpgsqlConnection connection; 44 | 45 | while (true) 46 | { 47 | try 48 | { 49 | connection = new NpgsqlConnection(connectionString); 50 | connection.Open(); 51 | break; 52 | } 53 | catch (SocketException) 54 | { 55 | Console.Error.WriteLine("Waiting for db"); 56 | Thread.Sleep(1000); 57 | } 58 | catch (DbException) 59 | { 60 | Console.Error.WriteLine("Waiting for db"); 61 | Thread.Sleep(1000); 62 | } 63 | } 64 | 65 | Console.Error.WriteLine("Connected to db"); 66 | 67 | var command = connection.CreateCommand(); 68 | command.CommandText = @"CREATE TABLE IF NOT EXISTS votes ( 69 | id VARCHAR(255) NOT NULL UNIQUE, 70 | vote VARCHAR(255) NOT NULL 71 | )"; 72 | command.ExecuteNonQuery(); 73 | 74 | return connection; 75 | } 76 | 77 | private static ConnectionMultiplexer OpenRedisConnection(string hostname) 78 | { 79 | // Use IP address to workaround hhttps://github.com/StackExchange/StackExchange.Redis/issues/410 80 | var ipAddress = GetIp(hostname); 81 | Console.WriteLine($"Found redis at {ipAddress}"); 82 | 83 | while (true) 84 | { 85 | try 86 | { 87 | Console.Error.WriteLine("Connected to redis"); 88 | return ConnectionMultiplexer.Connect(ipAddress); 89 | } 90 | catch (RedisConnectionException) 91 | { 92 | Console.Error.WriteLine("Waiting for redis"); 93 | Thread.Sleep(1000); 94 | } 95 | } 96 | } 97 | 98 | private static string GetIp(string hostname) 99 | => Dns.GetHostEntryAsync(hostname) 100 | .Result 101 | .AddressList 102 | .First(a => a.AddressFamily == AddressFamily.InterNetwork) 103 | .ToString(); 104 | 105 | private static void UpdateVote(NpgsqlConnection connection, string voterId, string vote) 106 | { 107 | var command = connection.CreateCommand(); 108 | try 109 | { 110 | command.CommandText = "INSERT INTO votes (id, vote) VALUES (@id, @vote)"; 111 | command.Parameters.AddWithValue("@id", voterId); 112 | command.Parameters.AddWithValue("@vote", vote); 113 | command.ExecuteNonQuery(); 114 | } 115 | catch (DbException) 116 | { 117 | command.CommandText = "UPDATE votes SET vote = @vote WHERE id = @id"; 118 | command.ExecuteNonQuery(); 119 | } 120 | finally 121 | { 122 | command.Dispose(); 123 | } 124 | } 125 | } 126 | } -------------------------------------------------------------------------------- /serverless-docker-voting-app/vote/templates/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | {{option_a}} vs {{option_b}}! 6 | 7 | 8 | 9 | 10 | 141 | 142 | 143 | 144 |
145 |
146 |

{{option_a}} vs {{option_b}}!

147 |
148 | 149 | 150 |
151 |
152 | (Tip: you can change your vote) 153 |
154 |
155 | Processed by container ID {{hostname}} 156 |
157 |
158 |
159 | 160 | 161 | 162 | {% if vote %} 163 | 177 | {% endif %} 178 | 179 | 180 | -------------------------------------------------------------------------------- /swarm_galera_wordpress/README.md: -------------------------------------------------------------------------------- 1 | #Docker Swarm for MySQL Cluster & WordPress 2 | 建立 MySQL Galera 叢集,用 Swarm Cluster 快速建立 Master/Master DB 架構 3 | 此範例將上個練習 [Docker Compose for MySQL Cluster & WordPress](https://philipz.github.io/tech/2016/08/19/compose_galera_wp.html) ,改成 Docker new Swarm 方式,部署到多台伺服器,與前面練習相同,再配合 WordPress,達到動態配置和負載平衡的分散式架構,延伸 [Docker-Compose & Service Discovery](https://philipz.github.io/tech/2016/08/02/compose_dns.html) 課程,練習使用 docker swarm 及 docker service 等等新版指令,可動態擴展服務,訓練未來實際營運環境之使用經驗。 4 | 5 | #New Swarm Mode Cluster 6 | ##建立 Swarm 叢集 7 | 先確認版本是否為 1.12?! `docker -v`{{execute}} 8 | ,看一下這新 Swarm Mode 有哪些指令。 `docker swarm --help`{{execute HOST1}} 9 | 10 | 接下來,初始化 Docker Swarm ,執行 `docker swarm init`{{execute HOST1}} 。 11 | 便會出現 Docker swarm join 的 Manager Token 和 Worker Token ,請先複製下來,在另一台伺服器加入叢集時需用到。 12 | 13 | 請選擇加入成為 Manager 或 Worker 的 Token: 14 | 15 | Manager - `token=$(docker -H [[HOST_IP]]:2345 swarm join-token -q manager) && echo $token`{{execute HOST2}} 16 | 17 | Worker - `token=$(docker -H [[HOST_IP]]:2345 swarm join-token -q worker) && echo $token`{{execute HOST2}} 18 | 19 | 加入到 Docker Swarm 叢集, `docker swarm join [[HOST_IP]]:2377 --token $token `{{execute HOST2}}。 20 | 21 | 叢集節點相關指令說明,`docker node -h`{{execute HOST1}}, 22 | 列出所有節點 `docker node ls`{{execute HOST1}}。 23 | 24 | #建立 Galera Cluster 25 | ##新增 Docker Network 26 | 查看 Docekr Network 相關指令,`docker network -h`{{execute HOST1}}, 27 | 執行 `docker network create -d overlay galera`{{execute HOST1}}, 28 | 新增名為 galera 的層疊網路。 29 | 30 | 與上個練習中的 `docker network create mysql` 指令不同,須指定 overlay 層疊網路之驅動器,才能在 Swarm Cluster 中跨伺服器。 31 | 32 | 確認內容 `docker network ls`{{execute HOST1}} , 33 | 若在上一步驟,以不同身分(Manager 和 Worker)加入,所產生的結果會有所不同,當以 Manager 身分加入,會立即同步其 Docker Network 的設定,因為其 Manager 的 K/V 是立即同步,若以 Worker 身分加入,則在服務部署到其伺服器時,才會生效。查看另一台 `docker network ls`{{execute HOST2}}, 34 | 詳細說明,請參閱[Understand Docker container networks](https://docs.docker.com/engine/userguide/networking/)。 35 | 36 | ##啟動 Galera 相關服務 37 | ###Master 38 | 所有的 Swarm 服務都必須在 Manager 上操作,而 Manager 數量建議為三台以上,原因請見[拜占庭將軍問題](http://www.twword.com/wiki/%E6%8B%9C%E5%8D%A0%E5%BA%AD%E5%B0%87%E8%BB%8D%E5%95%8F%E9%A1%8C),由 [Leslie Lamport](http://news.sciencenet.cn/htmlnews/2015/12/333114.shtm) 所提出。 39 | 執行 `docker service create --name master --network galera erkules/galera:basic --wsrep-cluster-name=local-test --wsrep-cluster-address=gcomm://`{{execute HOST1}} 40 | 41 | 查看服務清單,`docker service ls`{{execute HOST1}}, 42 | 確認 Master 服務狀況 `docker service ps master`{{execute HOST1}}。 43 | 44 | ###Galera 45 | `docker service create --name galera --network galera erkules/galera:basic --wsrep-cluster-name=local-test --wsrep-cluster-address=gcomm://master`{{execute HOST1}} 46 | 47 | 檢查其狀況 `docker service ps galera`{{execute HOST1}} 、 48 | `docker service ls`{{execute HOST1}} 49 | 50 | ##確認 Galera Cluster 數量 51 | 52 | 查看容器狀況 `docker ps`{{execute HOST1}}, 53 | 登入到 Master 容器中,`docker exec -ti XXXXX bash`, 54 | 執行 `mysql -e 'show status like "wsrep_cluster_size"'`{{execute HOST1}}, 55 | 確認 DB 叢集狀況。 56 | 57 | 同樣的步驟,亦在另一台伺服器上執行。`docker ps`{{execute HOST2}}, 58 | `docker exec -ti XXXXX bash`,`mysql -e 'show status like "wsrep_cluster_size"'`{{execute HOST2}}, 59 | 確認後離開`exit`{{execute HOST2}}。 60 | 61 | #建立 Wordpress 服務 62 | ##準備資料庫 63 | 再來設定 Wordpress 所需的資料庫和帳號權限。 64 | 執行 `mysql`{{execute HOST1}}, 65 | 資料庫:`CREATE DATABASE wordpress;`{{execute HOST1}}, 66 | 帳號:`CREATE USER 'wordpress'@'%' IDENTIFIED BY 'PASSWORD';`{{execute HOST1}}, 67 | 權限:`GRANT ALL PRIVILEGES ON wordpress.* TO 'wordpress'@'%' WITH GRANT OPTION;`{{execute HOST1}}, 68 | 最後跳出 mysql 程式 `exit`{{execute HOST1}}, 69 | 並登出容器 `exit`{{execute HOST1}}。 70 | 71 | ##啟動 Wordpress 服務 72 | 只需執行 `docker service create --name wordpress --network galera -p 80:80 -e WORDPRESS_DB_HOST=galera:3306 -e WORDPRESS_DB_USER=wordpress -e WORDPRESS_DB_PASSWORD=PASSWORD wordpress:4.5`{{execute HOST1}} 73 | 74 | 查看服務清單,`docker service ls`{{execute HOST1}}, 75 | 確認 Wordpress 服務狀況 `docker service ps wordpress`{{execute HOST1}}。 76 | 請點選上方的 + 符號,選擇「Web Preview host port 80」,就可看到 Wordpress 安裝畫面。 77 | 78 | #Swarm 服務擴展與升級 79 | ##擴展 Wordpress 容器數量 80 | 與 Docker Compose 指令類似,只需 `docker service scale wordpress=2`{{execute HOST1}}, 81 | 就完成橫向擴展,查看一下服務狀況 `docker service ps wordpress`{{execute HOST1}} 。 82 | 83 | 請點選另一台伺服器上方的 + 符號,選擇「Web Preview host port 80」,亦可看到 Wordpress 安裝畫面。 84 | 85 | 如果要確認 Swarm 叢集的自動負載平衡,可以登入到 Wordpress 其中一個容器,新增一個 test.html 86 | ,`echo "Test LB!" > test.html`,再用瀏覽器查看 test.html 的結果,就可發現,更新網頁兩次就會出現一次,即便在同一台伺服器上。 87 | 88 | ##捲動式更新服務(Rolling updates) 89 | 新版 Swarm 還提供[捲動更新功能](https://docs.docker.com/engine/swarm/swarm-tutorial/rolling-update/),只需要執行 90 | ``` 91 | docker service update \ 92 | --name wordpress \ 93 | --image wordpress:latest \ 94 | --update-delay 10s \ 95 | --update-parallelism 1 \ 96 | wordpress 97 | ```{{execute HOST1}} 98 | 99 | 就可將 Wordpress 更新至最新版。 100 | 101 | 查看 Wordpress 服務更新狀況, `docker service ps wordpress`{{execute HOST1}}。 102 | 103 | #SUMMARY 104 | 此示範將上一個只適用於開發測試環境的範例,使用 Docker Swarm 容器協同運作管理工具,部署到多台虛擬主機上。 105 | 106 | 亦善用這 overlay 層疊網路,很輕鬆就可配置出可動態擴展的架構,並且無須額外設定,即可達到動態配置和負載平衡。 107 | 108 | 各位可嘗試將[投票微服務範例](https://editor.katacoda.com/editor/docker/courses/docker2016/1)改成 Swarm 服務,而目前 Docker Compose 定義檔部署到 Swarm Cluster,需先轉成 [Distributed Application Bundles(DAB)](https://blog.docker.com/2016/06/docker-app-bundle/) 檔案格式,且仍處於[實驗階段](https://github.com/docker/docker/releases)。不過 Docker Compose 已經可以產生出 DAB 檔案, **docker-compose bundle -h**。 109 | -------------------------------------------------------------------------------- /compose_galera_wordpress/README.md: -------------------------------------------------------------------------------- 1 | #Docker Compose for MySQL Cluster & WordPress 2 | 建立 MySQL Galera 叢集,用 Docker Compose 快速建立 Master/Master DB 架構 3 | 4 | 示範如何將書中 MySQL Galera 叢集,改寫 Compose YAML檔案及參數,建置出 DB Mater/Master 架構,再配合 WordPress,以及上一個練習,[Compose & Service Discovery](https://philipz.github.io/tech/2016/08/02/compose_dns.html) 所學習到的 DNS-based 負載平衡機制,架設 WP 的 HA (高可用性)架構。 5 | ##Galera Cluster 原出處: 6 | * [Getting started Galera with Docker, part 1](http://galeracluster.com/2015/05/getting-started-galera-with-docker-part-1/) 7 | * [Getting Started Galera with Docker, part 2](http://galeracluster.com/2015/05/getting-started-galera-with-docker-part-2-2/) 8 | 9 | #準備環境 10 | ##Install Docker Machine 0.8.0 11 | 為快速建立雲端虛擬機,請安裝 Docekr Machine ,執行 ```wget https://github.com/docker/machine/releases/download/v0.8.0/docker-machine-`uname -s`-`uname -m` && \ 12 | sudo mv docker-machine-`uname -s`-`uname -m` /usr/local/bin/docker-machine && \ 13 | sudo chmod +x /usr/local/bin/docker-machine```{{execute}}, 14 | 確認版本 `docker-machine -v`{{execute}} 。 15 | 16 | ##Install Docker 1.12 17 | 執行 `sudo apt-get -y update`{{execute}} 18 | 更新套件,接著安裝新版 Docker, `sudo apt-get install -y docker-engine`{{execute}} 19 | ,選擇保留原本設定,按 `N`{{execute}} ,完成後,執行 `docker -v` 確認版本。 20 | ##Install Docker Compose 1.8.0 21 | Docker Composer V2 需要配合 Docker 1.10 之後版本, 22 | 依照 [Compose 文件](https://github.com/docker/compose/releases),執行 ```curl -L https://github.com/docker/compose/releases/download/1.8.0/docker-compose-`uname -s`-`uname -m` > ./docker-compose```{{execute}} 23 | 和 `chmod +x ./docker-compose && sudo mv ./docker-compose /usr/local/bin/docker-compose`{{execute}} 24 | ,完成 docker-compose 安裝,一樣確認版本 `docker-compose -v`{{execute}} 。 25 | 26 | ##建立 Azure 虛擬機 27 | 為真實模擬實際營運環境,使用 Docker Machine 快速建立 VM ,執行 `docker-machine create -d azure --azure-subscription-id="XXXXX" --azure-location="westeurope" --azure-image canonical:ubuntuserver:16.04.0-LTS:16.04.201608150 --azure-size Standard_A1 --engine-install-url https://get.docker.com docker-00-node01`{{execute}}, 28 | 建立完成,利用 **docker-machine env** 指令將 Docker Engine Server 指定到遠端 Azure 主機, `eval $(docker-machine env docker-00-node01)`{{execute}}, 29 | 輸入 `docker info`{{execute}} 確認電腦資訊。 30 | 31 | #解說 Galera 定義檔 32 | ##Docker Network 33 | Docker Network 是從 Docker 1.9 所新增的功能,可用來建立一個跨多台 Docker 伺服器的層疊網路,其利用 VXLAN 通訊協定。層疊技術的好處在於它提供每個容器具有相同子網路的 IP 位址,並且也能透過變更每個容器的 /etc/hosts 來管理名稱解析,因此每個容器都啟動在相同層疊網路,用各自的容器名稱,就可連線到其他任何一個容器。 34 | 35 | 執行 `docker network -h`{{execute}} 36 | ,來查看有哪些指令。 37 | 38 | ##複製範例庫 39 | 請執行 `git clone https://github.com/philipz/compose_galera_wordpress`{{execute}}, 40 | 切換到此範例目錄,`cd compose_galera_wordpress`{{execute}}, 41 | 首先,來看 galera.yml 定義檔內容: 42 | ``` 43 | version: "2" 44 | 45 | services: 46 | master: 47 | image: erkules/galera:basic 48 | container_name: master 49 | volumes: 50 | - /data:/var/lib/mysql 51 | networks: 52 | - mysql 53 | command: --wsrep-cluster-name=local-test --wsrep-cluster-address=gcomm:// 54 | 55 | slave: 56 | depends_on: 57 | - master 58 | image: erkules/galera:basic 59 | networks: 60 | - mysql 61 | command: --wsrep-cluster-name=local-test --wsrep-cluster-address=gcomm://master 62 | 63 | networks: 64 | mysql: 65 | ``` 66 | 主要是由兩個服務所組成,分別是 Master 和 Slave ,但此 Galera Cluster 是 Master-Master 資料庫架構,此命名只是方便識別。 67 | Master 服務先啟動,方便 Slave 利用那 *Command:* `--wsrep-cluster-name=local-test --wsrep-cluster-address=gcomm://master` 來連線到 Master,並且加上 *depends_on:* 設定,確保 Master 服務啟動好,才執行 Slave 服務,相關啟動順序細節,請參閱 [Controlling startup order in Compose](https://docs.docker.com/compose/startup-order/)。 68 | 69 | 最下面 *networks:* 則是建立 Docker Network ,與 `docker network create mysql` 指令相同。而 Master 和 Slave 服務都設定在 mysql 層疊網路上。 70 | 71 | #建立 Galera Cluster 72 | ##啟動 Galera Cluster 73 | 瞭解了 Compose 定義檔內容,接著就是啟動這服務。執行 `docker-compose -f galera.yml up -d`{{execute}}, 74 | 等待 pull 那 Galera 映像檔後,就建置完成。 75 | 76 | 顯示服務的標準輸出結果,可執行 `docker-compose -f galera.yml logs slave`{{execute}}, 77 | 確認服務是否有錯誤訊息。 78 | 79 | 若其中有服務未完成啟動,可執行 `docker-compose -f galera.yml up -d slave`{{execute}}, 80 | 嘗試再一次啟動容器服務。 81 | 82 | 查看其服務的狀態, `docker-compose -f galera.yml ps`{{execute}}, 83 | 為何不直接執行 `docker-compose ps`{{execute}}, 84 | 反而加上 **-f galera.yml** 是因為,docker-compose 預設使用檔案名稱為 *docker-compose.yml* ,若不用此名稱,就需要透過 **-f** 指定。 85 | 86 | 確認啟動完成,再登入到容器中,確認資料庫叢集狀態,`docker exec -ti master bash`{{execute}}, 87 | 進入容器後,執行 `mysql -e 'show status like "wsrep_cluster_size"'`{{execute}}, 88 | 即顯示目前叢集數量。 89 | 90 | #解說 Wordpress 定義檔 91 | ##準備資料庫 92 | 再來設定 Wordpress 所需的資料庫和帳號權限。 93 | 執行 `mysql`{{execute}}, 94 | 資料庫:`CREATE DATABASE wordpress;`{{execute}}, 95 | 帳號:`CREATE USER 'wordpress'@'%' IDENTIFIED BY 'PASSWORD';`{{execute}}, 96 | 權限:`GRANT ALL PRIVILEGES ON wordpress.* TO 'wordpress'@'%' WITH GRANT OPTION;`{{execute}}, 97 | 最後跳出 mysql 程式 `exit`{{execute}}, 98 | 並登出容器 `exit`{{execute}}。 99 | 100 | ##Wordpress 定義檔 101 | 接著,看一下 *wordpress.yml* 內容: 102 | ``` 103 | version: "2" 104 | 105 | services: 106 | wordpress: 107 | image: wordpress 108 | networks: 109 | - mysql 110 | environment: 111 | - WORDPRESS_DB_HOST=slave:3306 112 | - WORDPRESS_DB_USER=wordpress 113 | - WORDPRESS_DB_PASSWORD=PASSWORD 114 | ports: 115 | - "80:80" 116 | 117 | networks: 118 | mysql: 119 | ``` 120 | 與之前 *galera.yml* 定義檔相同,都是使用 mysql 的層疊網路,直接利用官方 wordpress 映像檔,故需定義相關環境變數,請注意那 *WORDPRESS_DB_HOST=slave:3306* 是連線到 slave 服務容器。 121 | 122 | #建立 Wordpress 123 | ##啟動 Wordpress 124 | 執行 `docker-compose -f wordpress.yml up -d`{{execute}}, 125 | 等待 pull 那 Wordpress 映像檔後,便建置完成。 126 | 127 | 啟動後,執行 `docker-machine ls`{{execute}}, 128 | 用瀏覽器開啟此 IP 就可看到 Wordpress 安裝畫面,並依指示完整安裝。 129 | 130 | ##停止所有服務 131 | 都操作完成後,便先停止 Wordpress 服務,`docker-compose -f wordpress.yml down`{{execute}}, 132 | 再來停止全部 Galera 服務,`docker-compose -f galera.yml down`{{execute}}。 133 | 完成後,確認目前容器狀況,`docker ps`{{execute}}。 134 | 135 | ##合併 Galera 和 Wordpress 136 | 最後,將兩個定義檔合併成一個,請見 *galera_wordpress.yml* 內容,接著一次啟動所有服務, `docker-compose -f galera_wordpress.yml up -d`{{execute}}, 137 | 確認所有服務的狀態, `docker-compose -f galera_wordpress.yml ps`{{execute}}, 138 | 用瀏覽器開啟此虛擬機 IP ,就可看到 Wordpress 已安裝好畫面。 139 | 140 | ##動態擴展 141 | 之前查看過資料庫叢集數量,此時動態增加 Slave 的數量,執行 `docker-compose -f galera_wordpress.yml scale wordpress=2`{{execute}}, 142 | 擴展完成,可登入到 wordpress 容器中,加上 test.html 來驗證負載平衡功能。 143 | 144 | #SUMMARY 145 | 此操作,示範如何使用 Docker Compose 和 Docker Network 整合之功能,善用這 overlay 層疊網路,很輕鬆就可配置出可動態擴展的架構,並且無須額外設定,即可達到動態配置和負載平衡,不過此範例只適用於開發測試環境,若要應用到營運環境,則須配合 Docker Swarm 容器協同運作管理工具,部署到多台虛擬主機上。 146 | -------------------------------------------------------------------------------- /circleci/README.md: -------------------------------------------------------------------------------- 1 | #Docker Compose & CircleCI 2 | 利用投票微服務範例,來示範如何使用 Github 結合 CircleCI 自動化建構微服務架構中的單一容器 3 | 4 | 示範 Docker 在 CircleCI 的持續整合(CI)、持續交付(CD)之應用,以[之前的投票微服務課程](https://philipz.github.io/tech/2016/08/08/vote_microservice.html)中的 Vote 服務,修改其 Python 程式來操作,在 CircleCI 建置出 Docker 映像檔,並整合 Docker Compose 建置出開發環境,撰寫 Test Script (docker run、curl,或是其他測試軟體等) ,自動測試並驗證其程式正確性,再發布到 Docker Hub 上。 5 | 6 | #複製程式碼 7 | 8 | ##下載範例程式 9 | 首先複製投票範例程式,`git clone https://github.com/docker/example-voting-app`{{execute}}, 10 | 切換到 *example-voting-app* 目錄,`cd example-voting-app`{{execute}}, 11 | 查看是否包含 Python 語言寫的 vote 目錄,`ls -l`{{execute}}, 12 | 回到 HOME 目錄,`cd ~`{{execute}}。 13 | 14 | ##建立 Git Repo. 15 | 登入到 Github ,在 Repositories 頁面,新增一個 Repo. ,如下圖: 16 | 17 | ![git_new1](https://cloud.githubusercontent.com/assets/664465/17506273/0fefed38-5e3a-11e6-91f5-b16e0ca998a2.png) 18 | 19 | 輸入專案名稱,**circlecidemo**,再按下 *Create repository* 按鈕。 20 | 21 | ![git_name](https://cloud.githubusercontent.com/assets/664465/17505759/f1645bf0-5e35-11e6-9c99-7907a844cd7c.png) 22 | 23 | 這樣便建立好一個空的 git 儲存庫,接著複製到本地端, `git clone https://github.com/philipz/circlecitest`{{execute}}, 24 | 進入到 circlecitest 目錄, `cd circlecitest`{{execute}}。 25 | 26 | ##複製 vote 程式 27 | 將 *example-voting-app* 底下 *vote* 目錄中的所有內容,複製到 *circlecitest*,`cp -R ~/example-voting-app/vote/* ./`{{execute}} , 28 | 便完成程式碼儲存庫的設定和配置。 29 | 30 | #撰寫 Docker Compose 定義檔 31 | 32 | 因為這投票微服務範例,包含五個容器服務元件,若不在 CI 環境上做系統整體測試,只做單元測試可能會有所疏漏,所以我們亦在 CircleCI 上使用 Docker Compose ,建置出一模一樣的環境,免除這樣的測試漏洞。所以複製 *example-voting-app* 目錄下的 **docker-compose.yml** 到 *circlecitest* 目錄中,`cp ~/example-voting-app/docker-compose.yml ./`{{execute}}。 33 | 34 | 這範例主要是針對 Python 程式部分來建置 35 | vote 服務的 *philipz/votingapp_vote* 映像檔,所以改寫這 **docker-compose.yml** 檔案,將非 vote 服務的四個容器都採用映像檔方式,改寫成下面內容: 36 | ``` 37 | version: "2" 38 | 39 | services: 40 | vote: 41 | image: philipz/votingapp_vote 42 | command: python app.py 43 | ports: 44 | - "5000:80" 45 | 46 | redis: 47 | image: redis:alpine 48 | ports: ["6379"] 49 | 50 | worker: 51 | image: philipz/votingapp_worker 52 | 53 | db: 54 | image: postgres:9.4 55 | 56 | result: 57 | image: philipz/votingapp_result 58 | ports: 59 | - "80:80" 60 | - "5858:5858" 61 | ``` 62 | 可直接複製現成檔案,`wget https://raw.githubusercontent.com/philipz/circlecitest/master/docker-compose.yml`{{execute}} 。 63 | 64 | #準備測試腳本 65 | 66 | 在 [example-voting-app/result](https://github.com/docker/example-voting-app/tree/master/result) 目錄中,其實有 Node.js 的測試程式,主要是透過 [PhantomJS](http://phantomjs.org/) 工具來測試,跟之前一樣複製到 *circlecitest* 目錄中,`cp -R ~/example-voting-app/result/tests ./`{{execute}}, 67 | 而原本的測試腳本是在本地端使用,需改寫成適合 Circle CI 環境,首先移除掉 while 這行 `while ! timeout 1 bash -c "echo > /dev/tcp/vote/80"; do sleep 1; done`,接著將 *http://vote* 改成 *http://localhost:5000* ,對應上一個步驟 **docker-compose.yml** 檔案中 vote 服務的 *ports: - "5000:80"*,再將 *http://result* 改成 *http://localhost* ,正好對應 result 服務的 *ports: - "80:80"*,改寫之後的結果如下: 68 | ``` 69 | #!/bin/sh 70 | curl -sS -X POST --data "vote=b" http://localhost:5000 > /dev/null 71 | sleep 10 72 | if phantomjs render.js http://localhost | grep -q '1 vote'; then 73 | echo -e "\e[42m------------" 74 | echo -e "\e[92mTests passed" 75 | echo -e "\e[42m------------" 76 | exit 0 77 | fi 78 | echo -e "\e[41m------------" 79 | echo -e "\e[91mTests failed" 80 | echo -e "\e[41m------------" 81 | exit 1 82 | ``` 83 | 可直接複製現成檔案,`wget 84 | https://raw.githubusercontent.com/philipz/circlecitest/master/tests/tests.sh`{{execute}} 。 85 | 86 | #撰寫 Circle CI 設定檔 87 | 88 | 接下來,新增 *circleci.yml* 檔案,內容如下,可直接複製現成檔案。 `wget https://raw.githubusercontent.com/philipz/circlecitest/master/circle.yml`{{execute}} 89 | ``` 90 | machine: 91 | pre: 92 | - curl -sSL https://s3.amazonaws.com/circle-downloads/install-circleci-docker.sh | bash -s -- 1.10.0 93 | services: 94 | - docker 95 | node: 96 | version: 0.10.22 97 | 98 | dependencies: 99 | override: 100 | - docker info 101 | - docker -v 102 | - docker build -t philipz/votingapp_vote . 103 | test: 104 | override: 105 | - curl -L https://github.com/docker/compose/releases/download/1.8.0/docker-compose-`uname -s`-`uname -m` > ./docker-compose 106 | - chmod +x ./docker-compose 107 | - ./docker-compose -v 108 | - ./docker-compose up -d 109 | - npm install -g phantomjs 110 | - cd test && ./tests.sh 111 | deployment: 112 | hub: 113 | branch: master 114 | commands: 115 | - docker login -e $DOCKER_EMAIL -u $DOCKER_USER -p $DOCKER_PASS 116 | - docker push philipz/votingapp_vote 117 | ``` 118 | 那 Circle CI 已經支援 Docker 服務,為何又要重新安裝?因為 Docker Engine 要 1.10 版之後才支援 Docker Compose version 2,而 Circle CI 預設的 Docker Engine 版本太舊,所以必須自行安裝,因此仍舊需要使用 `service: - docker` 。 119 | 120 | 再來配合上一個步驟的測試腳本,選擇 Node.js 環境,`node: version: 0.10.22`。而建置程式過程都寫在 `dependencies:` 這區塊,其實只有一行 `docker build -t philipz/votingapp_vote .`。接著是測試區塊 `test:` ,先安裝新版 **Docker Compose** ,再把整個投票微服務系統執行起來, ` 121 | docker-compose up -d`,最後安裝 PhantomJS 和執行上一步驟所準備的 *tests.sh* 腳本。 122 | 123 | ##上傳到 Github 124 | 全部檔案都改寫好,就新增所有檔案, `git add *`{{execute}} , 125 | 確認 `git commit -m "First init"`{{execute}} , 126 | 最後上傳 `git push`{{execute}} 。 127 | 128 | #使用 Circle CI 服務 129 | 130 | 最後一個步驟就是利用 [Circle CI](https://circleci.com/) 來建置並發佈到 Docker Hub 上。 131 | 132 | ##新增帳戶 133 | 按下那 *Sign Up* 按鈕: 134 | 135 | ![circle_signup](https://cloud.githubusercontent.com/assets/664465/17509832/91503752-5e4e-11e6-9879-48d3a76b0d44.png) 136 | 137 | 並直接使用 Github 帳號認證,直接按下 *Authorize with GitHub* 按鈕,便完成新增帳號。 138 | 139 | ##新增建置專案 140 | 在 [Circle CI 儀錶板](https://circleci.com/dashboard)上選擇, **ADD PROJECTS** ,點選 Github 選項。 141 | 142 | ![dashboard](https://cloud.githubusercontent.com/assets/664465/17509997/693844a2-5e4f-11e6-8e37-c70db5d31c95.png) 143 | 144 | 接著尋找 circlecitest 專案,按下 **Build project** ,就立即開始建置。 145 | ![circle_build](https://cloud.githubusercontent.com/assets/664465/17510281/df48780a-5e50-11e6-94b1-27e6e2eeee3c.png) 146 | 147 | ##發佈到 Docker Hub 設定 148 | 緊接著,若想在建置成功後,設定此建置專案的環境變數。按下專案旁的齒輪按鈕: 149 | 150 | ![circlecitest_setting](https://cloud.githubusercontent.com/assets/664465/17510772/de0beb8c-5e52-11e6-95cb-8b4602763264.png) 151 | 152 | 選擇環境變數, *Environment Variables* 153 | 154 | ![env_var](https://cloud.githubusercontent.com/assets/664465/17510877/53b81270-5e53-11e6-9aa1-9f6fed21a687.png) 155 | 156 | 新增三組環境變數,分別是您的 Docker Hub 帳號名、 Docker Hub EMAIL 和密碼。 157 | ![dockerhub_var](https://cloud.githubusercontent.com/assets/664465/17510942/9fbb2bbc-5e53-11e6-8d49-aba64cb553fd.png) 158 | 159 | 最後就可看到建置成功並上傳的 **綠燈** 。 160 | 161 | ![green_light](https://cloud.githubusercontent.com/assets/664465/17511626/61416ec0-5e56-11e6-8b3b-dc1e37ca02cb.png) 162 | 163 | #SUMMARY 164 | 165 | 這練習利用之前的 [Docker 官方 Web 投票微服務範例](https://philipz.github.io/tech/2016/08/08/vote_microservice.html),來示範如何使用 [Github](https://github.com/) 和 [CircleCI](https://circleci.com/) 166 | 透過 Docker 容器達到軟體[持續整合](https://zh.wikipedia.org/wiki/%E6%8C%81%E7%BA%8C%E6%95%B4%E5%90%88)(Continuous Integration))和[持續交付](https://zh.wikipedia.org/wiki/%E6%8C%81%E7%BA%8C%E4%BA%A4%E4%BB%98)(Continuous Delivery), 167 | 讓整個微服務架構中的單一容器元件可以自動化建置、測試後,上傳到企業內部的 [Docker registry server](https://github.com/docker/distribution/blob/master/docs/deploying.md) 存放映像檔,甚至呼叫 Webhook API 來自動部署營運環境。 168 | 169 | 延伸閱讀: 170 | 1. [此範例的 Github 專案](https://github.com/philipz/circlecitest) 171 | 2. [CircleCI 建置結果](https://circleci.com/gh/philipz/circlecitest) 172 | 3. [Continuous Delivery中文版](http://www.books.com.tw/products/0010653820) 173 | 4. [ThoughtWorks 的 CI 介紹](https://www.thoughtworks.com/continuous-integration ) 174 | 5. [ThoughtWorks 的 CD 介紹](https://www.thoughtworks.com/continuous-delivery) 175 | -------------------------------------------------------------------------------- /serverless-docker-voting-app/LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | Copyright 2016 Docker, Inc. 180 | 181 | Licensed under the Apache License, Version 2.0 (the "License"); 182 | you may not use this file except in compliance with the License. 183 | You may obtain a copy of the License at 184 | 185 | http://www.apache.org/licenses/LICENSE-2.0 186 | 187 | Unless required by applicable law or agreed to in writing, software 188 | distributed under the License is distributed on an "AS IS" BASIS, 189 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 190 | See the License for the specific language governing permissions and 191 | limitations under the License. 192 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /circleci/LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------