├── flink ├── conf │ ├── slaves │ ├── logback.xml │ ├── log4j.properties │ ├── flink-conf.yaml │ └── logback-yarn.xml ├── Dockerfile └── config-flink.sh ├── screenshots └── showplan.png ├── base ├── supervisor.conf └── Dockerfile ├── docker-compose.yml ├── beam-flink ├── Dockerfile └── config-flink-load-jar.sh ├── README.md └── LICENSE /flink/conf/slaves: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /screenshots/showplan.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/0x0ece/docker-beam-flink/HEAD/screenshots/showplan.png -------------------------------------------------------------------------------- /base/supervisor.conf: -------------------------------------------------------------------------------- 1 | ; Licensed to the Apache Software Foundation (ASF) under one 2 | ; or more contributor license agreements. See the NOTICE file 3 | ; distributed with this work for additional information 4 | ; regarding copyright ownership. The ASF licenses this file 5 | ; to you under the Apache License, Version 2.0 (the 6 | ; "License"); you may not use this file except in compliance 7 | ; with the License. You may obtain a copy of the License at 8 | ; 9 | ; http://www.apache.org/licenses/LICENSE-2.0 10 | ; 11 | ; Unless required by applicable law or agreed to in writing, software 12 | ; distributed under the License is distributed on an "AS IS" BASIS, 13 | ; WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | ; See the License for the specific language governing permissions and 15 | ; limitations under the License. 16 | 17 | [supervisord] 18 | nodaemon=true 19 | 20 | [include] 21 | files = /etc/supervisor/conf.d/*.conf 22 | -------------------------------------------------------------------------------- /flink/conf/logback.xml: -------------------------------------------------------------------------------- 1 | 18 | 19 | 20 | 21 | ${log.file} 22 | false 23 | 24 | %d{HH:mm:ss.SSS} [%thread] %-5level %logger{60} %X{sourceThread} - %msg%n 25 | 26 | 27 | 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /flink/conf/log4j.properties: -------------------------------------------------------------------------------- 1 | ################################################################################ 2 | # Licensed to the Apache Software Foundation (ASF) under one 3 | # or more contributor license agreements. See the NOTICE file 4 | # distributed with this work for additional information 5 | # regarding copyright ownership. The ASF licenses this file 6 | # to you under the Apache License, Version 2.0 (the 7 | # "License"); you may not use this file except in compliance 8 | # with the License. You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | ################################################################################ 18 | 19 | log4j.rootLogger=INFO, file 20 | 21 | # Log all infos in the given file 22 | log4j.appender.file=org.apache.log4j.FileAppender 23 | log4j.appender.file.file=${log.file} 24 | log4j.appender.file.append=false 25 | log4j.appender.file.layout=org.apache.log4j.PatternLayout 26 | log4j.appender.file.layout.ConversionPattern=%d{HH:mm:ss,SSS} %-5p %-60c %x - %m%n -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | ################################################################################ 2 | # Licensed to the Apache Software Foundation (ASF) under one 3 | # or more contributor license agreements. See the NOTICE file 4 | # distributed with this work for additional information 5 | # regarding copyright ownership. The ASF licenses this file 6 | # to you under the Apache License, Version 2.0 (the 7 | # "License"); you may not use this file except in compliance 8 | # with the License. You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | ################################################################################ 18 | 19 | jobmanager: 20 | image: dataradiant/beam-flink 21 | ports: 22 | - "48080:8080" 23 | - "48081:8081" 24 | - "220:22" 25 | expose: 26 | - "6123" 27 | - "22" 28 | command: /usr/local/flink/bin/config-flink-load-jar.sh jobmanager 29 | taskmanager: 30 | image: dataradiant/beam-flink 31 | ports: 32 | - "22" 33 | expose: 34 | - "6121" 35 | - "6122" 36 | links: 37 | - jobmanager:jobmanager 38 | -------------------------------------------------------------------------------- /flink/conf/flink-conf.yaml: -------------------------------------------------------------------------------- 1 | ################################################################################ 2 | # Licensed to the Apache Software Foundation (ASF) under one 3 | # or more contributor license agreements. See the NOTICE file 4 | # distributed with this work for additional information 5 | # regarding copyright ownership. The ASF licenses this file 6 | # to you under the Apache License, Version 2.0 (the 7 | # "License"); you may not use this file except in compliance 8 | # with the License. You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | ################################################################################ 18 | 19 | jobmanager.rpc.address: %jobmanager% 20 | jobmanager.rpc.port: 6123 21 | jobmanager.heap.mb: 128 22 | 23 | taskmanager.rpc.port: 6121 24 | taskmanager.data.port: 6122 25 | taskmanager.heap.mb: 256 26 | taskmanager.numberOfTaskSlots: %nb_slots% 27 | 28 | parallelization.degree.default: %parallelism% 29 | 30 | env.java.home: /usr/java/default 31 | 32 | #============================================================================== 33 | # Web Frontend 34 | #============================================================================== 35 | 36 | jobmanager.web.port: 8080 37 | -------------------------------------------------------------------------------- /flink/conf/logback-yarn.xml: -------------------------------------------------------------------------------- 1 | 18 | 19 | 20 | 21 | ${log.file} 22 | false 23 | 24 | %d{HH:mm:ss.SSS} [%thread] %-5level %logger{60} %X{sourceThread} - %msg%n 25 | 26 | 27 | 28 | 29 | 30 | %d{HH:mm:ss} %-5level %logger{60} %X{sourceThread} - %msg%n 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | -------------------------------------------------------------------------------- /beam-flink/Dockerfile: -------------------------------------------------------------------------------- 1 | ################################################################################ 2 | # Licensed to the Apache Software Foundation (ASF) under one 3 | # or more contributor license agreements. See the NOTICE file 4 | # distributed with this work for additional information 5 | # regarding copyright ownership. The ASF licenses this file 6 | # to you under the Apache License, Version 2.0 (the 7 | # "License"); you may not use this file except in compliance 8 | # with the License. You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | ################################################################################ 18 | 19 | FROM flink 20 | 21 | RUN curl -L https://github.com/ecesena/beam-starter/releases/download/v0.1/beam-starter-0.1.jar > /root/downloads/beam-starter-0.1.jar 22 | 23 | RUN curl http://www.gutenberg.org/cache/epub/1128/pg1128.txt > /tmp/kinglear.txt 24 | 25 | ADD config-flink-load-jar.sh /usr/local/flink/bin/ 26 | RUN chmod +x /usr/local/flink/bin/config-flink-load-jar.sh 27 | 28 | #TODO load jar at image level (Flink doesn't allow this yet) 29 | #RUN (/usr/local/flink/bin/config-flink.sh jobmanager &); \ 30 | # sleep 10 && \ 31 | # curl -H "Expect:" -F "jarfile=@/root/downloads/beam-starter-0.1.jar;type=application/java-archive" http://localhost:8080/jars/upload && \ 32 | # /usr/local/flink/bin/jobmanager.sh stop 33 | 34 | CMD ["/usr/local/flink/bin/config-flink.sh", "taskmanager"] 35 | -------------------------------------------------------------------------------- /flink/Dockerfile: -------------------------------------------------------------------------------- 1 | ################################################################################ 2 | # Licensed to the Apache Software Foundation (ASF) under one 3 | # or more contributor license agreements. See the NOTICE file 4 | # distributed with this work for additional information 5 | # regarding copyright ownership. The ASF licenses this file 6 | # to you under the Apache License, Version 2.0 (the 7 | # "License"); you may not use this file except in compliance 8 | # with the License. You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | ################################################################################ 18 | 19 | FROM base 20 | 21 | #add passless key to ssh 22 | RUN ssh-keygen -f ~/.ssh/id_rsa -t rsa -N '' 23 | RUN cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys && chmod 600 ~/.ssh/* 24 | 25 | ##Flink 1.0.3 Installation 26 | ###Download: 27 | RUN mkdir ~/downloads && cd ~/downloads && \ 28 | wget -q -O - http://apache.mirrors.pair.com/flink/flink-1.0.3/flink-1.0.3-bin-hadoop26-scala_2.10.tgz | tar -zxvf - -C /usr/local/ 29 | RUN cd /usr/local && ln -s ./flink-1.0.3 flink 30 | 31 | ENV FLINK_HOME /usr/local/flink 32 | ENV PATH $PATH:$FLINK_HOME/bin 33 | 34 | #config files (template) 35 | ADD conf/flink-conf.yaml /usr/local/flink/conf/ 36 | 37 | ADD config-flink.sh /usr/local/flink/bin/ 38 | RUN chmod +x /usr/local/flink/bin/config-flink.sh 39 | 40 | EXPOSE 6123 41 | EXPOSE 22 42 | 43 | CMD ["/usr/local/flink/bin/config-flink.sh", "taskmanager"] 44 | -------------------------------------------------------------------------------- /base/Dockerfile: -------------------------------------------------------------------------------- 1 | ################################################################################ 2 | # Licensed to the Apache Software Foundation (ASF) under one 3 | # or more contributor license agreements. See the NOTICE file 4 | # distributed with this work for additional information 5 | # regarding copyright ownership. The ASF licenses this file 6 | # to you under the Apache License, Version 2.0 (the 7 | # "License"); you may not use this file except in compliance 8 | # with the License. You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | ################################################################################ 18 | 19 | FROM ubuntu:trusty 20 | 21 | #requirements 22 | RUN apt-get update; apt-get install -y curl wget supervisor openssh-server openssh-client nano 23 | 24 | #priviledge separation directory 25 | RUN mkdir /var/run/sshd 26 | 27 | #install Java 7 Oracle JDK 28 | RUN mkdir -p /usr/java/default && \ 29 | curl -Ls 'http://download.oracle.com/otn-pub/java/jdk/7u51-b13/jdk-7u51-linux-x64.tar.gz' -H 'Cookie: oraclelicense=accept-securebackup-cookie' | \ 30 | tar --strip-components=1 -xz -C /usr/java/default/ 31 | ENV JAVA_HOME /usr/java/default/ 32 | 33 | #Install Java Open JDK 34 | #RUN apt-get install -y unzip openjdk-7-jre-headless 35 | #ENV JAVA_HOME=/usr/lib/jvm/java-7-openjdk-amd64/ 36 | 37 | 38 | RUN echo 'root:secret' | chpasswd 39 | 40 | #SSH as root... probably needs to be revised for security! 41 | RUN sed -i 's/PermitRootLogin without-password/PermitRootLogin yes/' /etc/ssh/sshd_config 42 | 43 | EXPOSE 22 44 | 45 | # supervisor base configuration 46 | ADD supervisor.conf /etc/supervisor/ 47 | 48 | # default command / not overridable CMD needed for supervisord 49 | #CMD ["supervisord", "-c", "/etc/supervisor.conf"] -------------------------------------------------------------------------------- /flink/config-flink.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | ################################################################################ 4 | # Licensed to the Apache Software Foundation (ASF) under one 5 | # or more contributor license agreements. See the NOTICE file 6 | # distributed with this work for additional information 7 | # regarding copyright ownership. The ASF licenses this file 8 | # to you under the Apache License, Version 2.0 (the 9 | # "License"); you may not use this file except in compliance 10 | # with the License. You may obtain a copy of the License at 11 | # 12 | # http://www.apache.org/licenses/LICENSE-2.0 13 | # 14 | # Unless required by applicable law or agreed to in writing, software 15 | # distributed under the License is distributed on an "AS IS" BASIS, 16 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 17 | # See the License for the specific language governing permissions and 18 | # limitations under the License. 19 | ################################################################################ 20 | 21 | 22 | 23 | 24 | CONF=/usr/local/flink/conf 25 | EXEC=/usr/local/flink/bin 26 | 27 | #set nb_slots = nb CPUs 28 | #let "nbslots=$2 * `nproc`" 29 | sed -i -e "s/%nb_slots%/`nproc`/g" $CONF/flink-conf.yaml 30 | 31 | #set parallelism 32 | sed -i -e "s/%parallelism%/1/g" $CONF/flink-conf.yaml 33 | 34 | if [ "$1" = "jobmanager" ]; then 35 | echo "Configuring Job Manager on this node" 36 | sed -i -e "s/%jobmanager%/`hostname -i`/g" $CONF/flink-conf.yaml 37 | $EXEC/jobmanager.sh start cluster 38 | 39 | elif [ "$1" = "taskmanager" ]; then 40 | echo "Configuring Task Manager on this node" 41 | sed -i -e "s/%jobmanager%/$JOBMANAGER_PORT_6123_TCP_ADDR/g" $CONF/flink-conf.yaml 42 | $EXEC/taskmanager.sh start 43 | fi 44 | 45 | #print out config - debug 46 | echo "config file: " && cat $CONF/flink-conf.yaml 47 | 48 | #add ENV variable to shell for ssh login 49 | echo "export JAVA_HOME=/usr/java/default;" >> ~/.profile 50 | echo "export PATH=$PATH:$JAVA_HOME/bin;" >> ~/.profile 51 | echo "export F=/usr/local/flink/;" >> ~/.profile 52 | #Uncomment for SSH connection between nodes without prompts 53 | #echo 'export FLINK_SSH_OPTS="-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no"' >> ~/.profile 54 | 55 | #run ssh server and supervisor to keep container running. 56 | /usr/sbin/sshd && supervisord -c /etc/supervisor/supervisor.conf 57 | -------------------------------------------------------------------------------- /beam-flink/config-flink-load-jar.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | ################################################################################ 4 | # Licensed to the Apache Software Foundation (ASF) under one 5 | # or more contributor license agreements. See the NOTICE file 6 | # distributed with this work for additional information 7 | # regarding copyright ownership. The ASF licenses this file 8 | # to you under the Apache License, Version 2.0 (the 9 | # "License"); you may not use this file except in compliance 10 | # with the License. You may obtain a copy of the License at 11 | # 12 | # http://www.apache.org/licenses/LICENSE-2.0 13 | # 14 | # Unless required by applicable law or agreed to in writing, software 15 | # distributed under the License is distributed on an "AS IS" BASIS, 16 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 17 | # See the License for the specific language governing permissions and 18 | # limitations under the License. 19 | ################################################################################ 20 | 21 | 22 | 23 | 24 | CONF=/usr/local/flink/conf 25 | EXEC=/usr/local/flink/bin 26 | 27 | #set nb_slots = nb CPUs 28 | #let "nbslots=$2 * `nproc`" 29 | sed -i -e "s/%nb_slots%/`nproc`/g" $CONF/flink-conf.yaml 30 | 31 | #set parallelism 32 | sed -i -e "s/%parallelism%/1/g" $CONF/flink-conf.yaml 33 | 34 | if [ "$1" = "jobmanager" ]; then 35 | echo "Configuring Job Manager on this node" 36 | sed -i -e "s/%jobmanager%/`hostname -i`/g" $CONF/flink-conf.yaml 37 | $EXEC/jobmanager.sh start cluster 38 | # load initial jar 39 | sleep 10 40 | curl -H "Expect:" -F "jarfile=@/root/downloads/beam-starter-0.1.jar;type=application/java-archive" http://localhost:8080/jars/upload 41 | 42 | elif [ "$1" = "taskmanager" ]; then 43 | echo "Configuring Task Manager on this node" 44 | sed -i -e "s/%jobmanager%/$JOBMANAGER_PORT_6123_TCP_ADDR/g" $CONF/flink-conf.yaml 45 | $EXEC/taskmanager.sh start 46 | fi 47 | 48 | #print out config - debug 49 | echo "config file: " && cat $CONF/flink-conf.yaml 50 | 51 | #add ENV variable to shell for ssh login 52 | echo "export JAVA_HOME=/usr/java/default;" >> ~/.profile 53 | echo "export PATH=$PATH:$JAVA_HOME/bin;" >> ~/.profile 54 | echo "export F=/usr/local/flink/;" >> ~/.profile 55 | #Uncomment for SSH connection between nodes without prompts 56 | #echo 'export FLINK_SSH_OPTS="-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no"' >> ~/.profile 57 | 58 | #run ssh server and supervisor to keep container running. 59 | /usr/sbin/sshd && supervisord -c /etc/supervisor/supervisor.conf 60 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Docker image with Apache Beam + Flink 2 | 3 | Read the blog post [A quick demo of Apache Beam with Docker](https://medium.com/@ecesena/a-quick-demo-of-apache-beam-with-docker-da98b99a502a). 4 | 5 | ## Beam & Flink on Docker 6 | 7 | Prerequisites: `docker` and `docker-compose` 8 | 9 | 1. Clone this repo 10 | 11 | 2. Deploy cluster and see config/setup log output (best run in a screen session) 12 | 13 | `docker-compose up` 14 | 15 | or deploy as a daemon (and return) 16 | 17 | `docker-compose up -d` 18 | 19 | 3. Scale the cluster up or down to *N* TaskManagers 20 | 21 | `docker-compose scale taskmanager=` 22 | 23 | ## Run Beam WordCount Pipeline 24 | 25 | Open the web UI on (exposed on port 48080) 26 | 27 | `open http://localhost:48080` 28 | 29 | or on Mac or Windows with `docker-machine` 30 | 31 | `open http://$(docker-machine ip default):48080` 32 | 33 | Next: 34 | 35 | 1. Click "Submit new Job" in the left menu 36 | 37 | 2. Flag the checkbox near `beam-starter-.jar` 38 | 39 | 3. Click on "Submit" (or "Show Plan") -- no param is needed, but you can play with that too 40 | 41 | ![Home Page](https://raw.githubusercontent.com/ecesena/docker-beam-flink/master/screenshots/showplan.png) 42 | 43 | ## Other Operations 44 | 45 | - Access the JobManager node with SSH (exposed on port 220) 46 | 47 | `ssh root@$(docker-machine ip default) -p 220` 48 | 49 | The password is "secret" 50 | 51 | - Kill the cluster 52 | 53 | `docker-compose kill` 54 | 55 | - Upload a jar to the cluster 56 | 57 | `scp -P 220 root@$(docker-machine ip default):/` 58 | 59 | - Run any Flink topology 60 | 61 | `ssh -p 220 root@$(docker-machine ip default) /usr/local/flink/bin/flink run -c ` 62 | 63 | or ssh to the job manager and run the topology from there. 64 | 65 | ## Ports 66 | 67 | - The Web Dashboard is on port `48080` 68 | - The Web Client is on port `48081` 69 | - JobManager RPC port `6123` (default, not exposed to host) 70 | - TaskManagers RPC port `6121` (default, not exposed to host) 71 | - TaskManagers Data port `6122` (default, not exposed to host) 72 | - JobManager SSH `220` 73 | - TaskManagers SSH: randomly assigned port, check wih `docker ps` 74 | 75 | Edit the `docker-compose.yml` file to edit port settings. 76 | 77 | ## Build Docker Images from Scratch 78 | 79 | Clone this repo, then run `sh build.sh`. 80 | 81 | ## TODO 82 | 83 | - Add the JAR to the front end during image building 84 | 85 | ## Open source 86 | 87 | - Forked from https://github.com/apache/flink/tree/master/flink-contrib/docker-flink 88 | - Apache Beam: https://beam.incubator.apache.org 89 | - Apache Flink: https://flink.apache.org 90 | - Starter repo for Apache Beam (included in this image): https://github.com/ecesena/beam-starter 91 | - Blog: [A quick demo of Apache Beam with Docker](https://medium.com/@ecesena/a-quick-demo-of-apache-beam-with-docker-da98b99a502a). 92 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------