├── repotext.txt ├── spark-standalone ├── requirements.txt ├── jupyter-conf.sh ├── project.sh ├── changelog.md ├── config.sh ├── config-3.2.4-3.2-3.10.12.sh ├── start-spark.sh ├── docker.info ├── docker-compose.yml ├── build-image.sh ├── Dockerfile ├── README.md └── LICENSE └── .gitignore /repotext.txt: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /spark-standalone/requirements.txt: -------------------------------------------------------------------------------- 1 | pyspark==3.2.4 2 | numpy 3 | scikit-learn 4 | pandas==1.5.3 5 | polars 6 | jupyter 7 | jupyterlab 8 | pyarrow 9 | -------------------------------------------------------------------------------- /spark-standalone/jupyter-conf.sh: -------------------------------------------------------------------------------- 1 | export PYSPARK_DRIVER_PYTHON=jupyter 2 | export PYSPARK_DRIVER_PYTHON_OPTS='notebook' 3 | export SPARK_HOME=venv 4 | 5 | -------------------------------------------------------------------------------- /spark-standalone/project.sh: -------------------------------------------------------------------------------- 1 | #! /usr/bin/bash 2 | ############################################################################################# 3 | # project.sh - Project metadata for CI/CD scripts 4 | # 5 | # 6 | ############################################################################################# 7 | 8 | export PROJECT_NAME="spark-standalone" 9 | export PROJECT_VERSION="0.0.4" 10 | export PROJECT_AUTHOR="ramtricks" 11 | export PROJECT_LICENSE="Artistic2" 12 | -------------------------------------------------------------------------------- /spark-standalone/changelog.md: -------------------------------------------------------------------------------- 1 | # changelog.md 2 | 3 | Version changing register document 4 | 5 | 6 | # Rules 7 | 8 | [ADD] - When new file is added 9 | 10 | [REM] - When file is removed 11 | 12 | [MOD] - When important code is modified 13 | 14 | [FIX] - Fixing actions 15 | 16 | # Changes 17 | 18 | # 0.0.4 19 | - [MOD] apps/test1/run-script.sh - Added worker to run-script.sh 20 | - [MOD] apps/test1/test-spark.py - Removed some config from test-spark.py 21 | - [MOD] docker-compose.yml - IMAGE_VERSION variable is now back to the docker-compose.yml 22 | - [MOD] requirements.txt - jupyterlab added to the requirements.txt 23 | - [FIX] start-spark.sh - The 'worker' variables was fixed 24 | - [ADD] changelog.md -------------------------------------------------------------------------------- /spark-standalone/config.sh: -------------------------------------------------------------------------------- 1 | #! /usr/bin/env bash 2 | ####################################################################################################################### 3 | # config.sh - Setup version of ecosystem applications(Spark, Hadoop and Python), SPARK_HOME, and the image name/version 4 | # of the docker image which will be built by build-image.sh 5 | # USE: source config.sh && docker-compose up 6 | ####################################################################################################################### 7 | # Loading project metadata 8 | source project.sh 9 | # Verison vars 10 | export SPARK_VERSION="3.2.4" 11 | export HADOOP_VERSION="3.2" 12 | export PYTHON_VERSION="3.10.12" 13 | # Docker Tag version 14 | export IMAGE_TAG="$PROJECT_VERSION" 15 | # System vars 16 | export TZ_STR=America/Sao_Paulo 17 | export NEW_USER="developer" 18 | export NEW_USER_PASSWORD="Dev#1842" 19 | # Spark config vars 20 | export SPARK_HOME=/opt/spark 21 | export SPARK_MASTER_PORT=7077 22 | export SPARK_WORKER_WEBUI_PORT=8080 23 | export SPARK_WORKER_PORT=7000 24 | # Java home in containers 25 | export JAVA_HOME=/opt/java 26 | # Docker no-cache option 27 | export DOCKER_NO_CACHE=1 28 | # Set ramtricks image tag name 29 | export IMAGE_VERSION="ramtricks/spark-stda-$SPARK_VERSION-hadoop-$HADOOP_VERSION-python-$PYTHON_VERSION:$IMAGE_TAG" 30 | -------------------------------------------------------------------------------- /spark-standalone/config-3.2.4-3.2-3.10.12.sh: -------------------------------------------------------------------------------- 1 | #! /usr/bin/env bash 2 | ####################################################################################################################### 3 | # config.sh - Setup version of ecosystem applications(Spark, Hadoop and Python), SPARK_HOME, and the image name/version 4 | # of the docker image which will be built by build-image.sh 5 | # USE: source config.sh && docker-compose up 6 | ####################################################################################################################### 7 | # Loading project metadata 8 | source project.sh 9 | # Verison vars 10 | export SPARK_VERSION="3.2.4" 11 | export HADOOP_VERSION="3.2" 12 | export PYTHON_VERSION="3.10.12" 13 | # Docker Tag version 14 | export IMAGE_TAG="$PROJECT_VERSION" 15 | # System vars 16 | export TZ_STR=America/Sao_Paulo 17 | export NEW_USER="developer" 18 | export NEW_USER_PASSWORD="Dev#1842" 19 | # Spark config vars 20 | export SPARK_HOME=/opt/spark 21 | export SPARK_MASTER_PORT=7077 22 | export SPARK_WORKER_WEBUI_PORT=8080 23 | export SPARK_WORKER_PORT=7000 24 | # Java home in containers 25 | export JAVA_HOME=/opt/java 26 | # Docker no-cache option 27 | export DOCKER_NO_CACHE=1 28 | # Set ramtricks image tag name 29 | export IMAGE_VERSION="ramtricks/spark-stda-$SPARK_VERSION-hadoop-$HADOOP_VERSION-python-$PYTHON_VERSION:$IMAGE_TAG" 30 | -------------------------------------------------------------------------------- /spark-standalone/start-spark.sh: -------------------------------------------------------------------------------- 1 | #! /usr/bin/env bash 2 | #################################################################################################################### 3 | # start-spark.sh 4 | # 5 | # Defines what master/worker deployment will be set when service up 6 | # 7 | # How to use it? 8 | # Run build-image.sh 9 | # Then, run docker-compose --env-file=config.sh up 10 | # 11 | #################################################################################################################### 12 | if [ -f "/home/develop/.bashrc" ]; 13 | then 14 | 15 | source /home/develop/.bashrc 16 | fi 17 | 18 | source /config.sh 19 | 20 | #. "$SPARK_HOME/bin/load-spark-env.sh" 21 | # When the spark work_load is master run class org.apache.spark.deploy.master.Master 22 | if [ "$SPARK_WORKLOAD" == "master" ]; 23 | then 24 | SPARK_MASTER_HOST=`hostname -i` 25 | export SPARK_MASTER_HOST 26 | 27 | cd "$SPARK_HOME"/bin && ./spark-class org.apache.spark.deploy.master.Master --ip "$SPARK_MASTER_HOST" \ 28 | --port "$SPARK_MASTER_PORT" \ 29 | --webui-port "$SPARK_MASTER_WEBUI_PORT" >> "$SPARK_MASTER_LOG" 30 | 31 | elif [ "$SPARK_WORKLOAD" == "worker" ]; 32 | then 33 | # When the spark work_load is worker run class org.apache.spark.deploy.master.Worker $SPARK_MASTER_HOST 34 | cd /opt/spark/bin && ./spark-class org.apache.spark.deploy.worker.Worker --webui-port "$SPARK_WORKER_WEBUI_PORT" "$SPARK_MASTER" >> "$SPARK_WORKER_LOG" 35 | 36 | elif [ "$SPARK_WORKLOAD" == "submit" ]; 37 | then 38 | echo "SPARK SUBMIT" 39 | else 40 | echo "Undefined Workload Type $SPARK_WORKLOAD, must specify: master, worker or submit" 41 | fi 42 | -------------------------------------------------------------------------------- /spark-standalone/docker.info: -------------------------------------------------------------------------------- 1 | Client: Docker Engine - Community 2 | Version: 26.0.2 3 | Context: default 4 | Debug Mode: false 5 | Plugins: 6 | buildx: Docker Buildx (Docker Inc.) 7 | Version: v0.14.0 8 | Path: /usr/libexec/docker/cli-plugins/docker-buildx 9 | compose: Docker Compose (Docker Inc.) 10 | Version: v2.26.1 11 | Path: /usr/libexec/docker/cli-plugins/docker-compose 12 | 13 | Server: 14 | Containers: 0 15 | Running: 0 16 | Paused: 0 17 | Stopped: 0 18 | Images: 10 19 | Server Version: 26.0.2 20 | Storage Driver: overlay2 21 | Backing Filesystem: btrfs 22 | Supports d_type: true 23 | Using metacopy: false 24 | Native Overlay Diff: true 25 | userxattr: false 26 | Logging Driver: json-file 27 | Cgroup Driver: systemd 28 | Cgroup Version: 2 29 | Plugins: 30 | Volume: local 31 | Network: bridge host ipvlan macvlan null overlay 32 | Log: awslogs fluentd gcplogs gelf journald json-file local splunk syslog 33 | Swarm: inactive 34 | Runtimes: runc io.containerd.runc.v2 35 | Default Runtime: runc 36 | Init Binary: docker-init 37 | containerd version: e377cd56a71523140ca6ae87e30244719194a521 38 | runc version: v1.1.12-0-g51d5e94 39 | init version: de40ad0 40 | Security Options: 41 | apparmor 42 | seccomp 43 | Profile: builtin 44 | cgroupns 45 | Kernel Version: 6.5.0-27-generic 46 | Operating System: Linux Mint 21.2 47 | OSType: linux 48 | Architecture: x86_64 49 | CPUs: 8 50 | Total Memory: 29.3GiB 51 | Name: eletricage 52 | ID: 1139f381-9a52-4a71-8e41-d38fd2c184d4 53 | Docker Root Dir: /var/lib/docker 54 | Debug Mode: false 55 | Username: ramtricks 56 | Experimental: false 57 | Insecure Registries: 58 | 127.0.0.0/8 59 | Live Restore Enabled: false 60 | 61 | -------------------------------------------------------------------------------- /spark-standalone/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3.3" 2 | services: 3 | spark-master: 4 | image: ${IMAGE_VERSION} 5 | ports: 6 | - "9091:8080" 7 | - "7077:7077" 8 | - "8888:8888" # jupyter 9 | volumes: 10 | - ./apps:/home/developer/pyspark-apps 11 | - ./data:/opt/spark-data 12 | - ./jars:/home/developer/jars 13 | environment: 14 | - SPARK_LOCAL_IP=spark-master 15 | - SPARK_WORKLOAD=master 16 | - SPARK_WORKER_CORES=2 17 | - SPARK_WORKER_MEMORY=1G 18 | - SPARK_DRIVER_MEMORY=1G 19 | - SPARK_EXECUTOR_MEMORY=2G 20 | 21 | spark-worker-a: 22 | image: ${IMAGE_VERSION} 23 | ports: 24 | - "9092:8080" 25 | - "7000:7000" 26 | depends_on: 27 | - spark-master 28 | environment: 29 | - SPARK_MASTER=spark://spark-master:7077 30 | - SPARK_WORKER_CORES=2 31 | - SPARK_WORKER_MEMORY=2G 32 | - SPARK_DRIVER_MEMORY=2G 33 | - SPARK_EXECUTOR_MEMORY=2G 34 | - SPARK_WORKLOAD=worker 35 | - SPARK_LOCAL_IP=spark-worker-a 36 | volumes: 37 | - ./apps:/home/developer/pyspark-apps 38 | - ./data:/opt/spark-data 39 | - ./jars:/home/developer/jars 40 | 41 | spark-worker-b: 42 | image: ${IMAGE_VERSION} 43 | ports: 44 | - "9093:8080" 45 | - "7001:7000" 46 | depends_on: 47 | - spark-master 48 | environment: 49 | - SPARK_MASTER=spark://spark-master:7077 50 | - SPARK_WORKER_CORES=2 51 | - SPARK_WORKER_MEMORY=2G 52 | - SPARK_DRIVER_MEMORY=2G 53 | - SPARK_EXECUTOR_MEMORY=2G 54 | - SPARK_WORKLOAD=worker 55 | - SPARK_LOCAL_IP=spark-worker-b 56 | volumes: 57 | - ./apps:/home/developer/pyspark-apps 58 | - ./data:/opt/spark-data 59 | - ./jars:/home/developer/jars 60 | 61 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # pdm 105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 106 | #pdm.lock 107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 108 | # in version control. 109 | # https://pdm.fming.dev/latest/usage/project/#working-with-version-control 110 | .pdm.toml 111 | .pdm-python 112 | .pdm-build/ 113 | 114 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 115 | __pypackages__/ 116 | 117 | # Celery stuff 118 | celerybeat-schedule 119 | celerybeat.pid 120 | 121 | # SageMath parsed files 122 | *.sage.py 123 | 124 | # Environments 125 | .env 126 | .venv 127 | env/ 128 | venv/ 129 | ENV/ 130 | env.bak/ 131 | venv.bak/ 132 | 133 | # Spyder project settings 134 | .spyderproject 135 | .spyproject 136 | 137 | # Rope project settings 138 | .ropeproject 139 | 140 | # mkdocs documentation 141 | /site 142 | 143 | # mypy 144 | .mypy_cache/ 145 | .dmypy.json 146 | dmypy.json 147 | 148 | # Pyre type checker 149 | .pyre/ 150 | 151 | # pytype static type analyzer 152 | .pytype/ 153 | 154 | # Cython debug symbols 155 | cython_debug/ 156 | 157 | # PyCharm 158 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 159 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 160 | # and can be added to the global gitignore or merged into this file. For a more nuclear 161 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 162 | #.idea/ 163 | -------------------------------------------------------------------------------- /spark-standalone/build-image.sh: -------------------------------------------------------------------------------- 1 | #! /usr/bin/env bash 2 | ########################################################################################################## 3 | # build-image.sh: Downloads the chosen Spark/Hadoop version file and Python version from Apache official 4 | # download site, set on 'config.sh' file. Then, run "docker build" command. 5 | # Dependencies: config.sh, project.sh 6 | # Usage: 7 | # source config.sh && ./build-image.sh 8 | ########################################################################################################## 9 | 10 | # Getting config from config.sh file. Check/Edit it first to run this script! 11 | source project.sh 12 | source config.sh 13 | 14 | function download() { 15 | url=$1 16 | output_name=$2 17 | if [ -z "$url" ]; then 18 | echo "URL can't be empty on download" 19 | fi 20 | wget_result="$(wget -NS "$url" 2>&1|grep "HTTP/"|awk '{print $2}') -O $output_name" 21 | if [ "$wget_result" == 200 ]; then 22 | echo "File downloaded" 23 | echo "" 24 | elif [ "$wget_result" == 304 ]; then 25 | echo "File not modified from local copy" 26 | else 27 | echo "Something went wrong downloading $url - status code($wget_result)" 28 | exit 1 29 | fi 30 | } 31 | 32 | # Checking for environment variables 33 | if [[ -z "$SPARK_VERSION" || -z "$HADOOP_VERSION" || -z "$PYTHON_VERSION" ]];then 34 | echo "ERROR: The variables 'SPARK_VERSION', 'HADOOP_VERSION' AND 'PYTHON_VERSION' must be set first! Exiting!" 35 | exit 1 36 | fi 37 | 38 | echo "Spark version is $SPARK_VERSION with Hadoop $HADOOP_VERSION" 39 | # Downloading Spark version 40 | echo "Checking Spark file" 41 | if [ ! -f apache-spark.tgz ]; then 42 | echo "Downloading Apache Spark $SPARK_VERSION with Hadoop $HADOOP_VERSION" 43 | wget -O apache-spark.tgz "https://archive.apache.org/dist/spark/spark-$SPARK_VERSION/spark-$SPARK_VERSION-bin-hadoop$HADOOP_VERSION.tgz" 44 | # spark_address="https://archive.apache.org/dist/spark/spark-$SPARK_VERSION/spark-$SPARK_VERSION-bin-hadoop$HADOOP_VERSION.tgz" 45 | download "$spark_address" "apache-spark.tgz" 46 | else 47 | echo "File apache-spark.tgz already exists" 48 | fi 49 | 50 | ## Downloading Python 51 | python_address="https://www.python.org/ftp/python/$PYTHON_VERSION/Python-$PYTHON_VERSION.tgz" 52 | python_file="python-$PYTHON_VERSION.tgz" 53 | echo "Checking Python source file" 54 | if [ ! -f "$python_file" ]; then 55 | echo "Downloading $python_file " 56 | # wget -O python-"$PYTHON_VERSION".tgz "$python_address" -O python-"$PYTHON_VERSION".tgz 57 | download "$python_address" "python-${PYTHON_VERSION}.tgz" 58 | else 59 | echo "File '$python_file' already exists" 60 | fi 61 | 62 | # Downloading the disgusting Java 63 | openjdk_link="https://download.java.net/openjdk/jdk11/ri/openjdk-11+28_linux-x64_bin.tar.gz" 64 | java_file="openjdk11.tar.gz" 65 | echo "Checking $java_file" 66 | if [ ! -f "$java_file" ]; then 67 | echo "Downloading Java from $openjdk_link" 68 | # wget -O "$java_file" "$openjdk_link" 69 | download "$openjdk_link" "$java_file" 70 | else 71 | echo "File '$java_file' is already downloaded!" 72 | fi 73 | 74 | # Building image 75 | echo "Building docker image $IMAGE_VERSION" 76 | echo "SPARK VERSION IS $SPARK_VERSION" 77 | echo "HADOOP VERSION IS $HADOOP_VERSION" 78 | echo "PYTHON VERSION IS $PYTHON_VERSION" 79 | # Exporting docker_command 80 | docker_command="docker build \ 81 | --build-arg SPARK_VERSION=$SPARK_VERSION \ 82 | --build-arg HADOOP_VERSION=$HADOOP_VERSION \ 83 | --build-arg PYTHON_VERSION=$PYTHON_VERSION \ 84 | --build-arg SPARK_HOME=$SPARK_HOME \ 85 | --build-arg TZ_STR=$TZ_STR \ 86 | --build-arg SPARK_HOME=$SPARK_HOME \ 87 | --build-arg SPARK_MASTER_PORT=$SPARK_MASTER_PORT \ 88 | --build-arg SPARK_WORKER_WEBUI_PORT=$SPARK_WORKER_WEBUI_PORT \ 89 | --build-arg SPARK_WORKER_PORT=$SPARK_WORKER_PORT \ 90 | --build-arg JAVA_HOME=$JAVA_HOME \ 91 | --build-arg NEW_USER=$NEW_USER \ 92 | --build-arg NEW_USER_PASSWORD=$NEW_USER_PASSWORD" 93 | # Checking if --no-cache will be included. It's set on config.sh 94 | if [ "$DOCKER_NO_CACHE" == 1 ] 95 | then 96 | docker_command="$docker_command --no-cache" 97 | fi 98 | # Including the image tag 99 | docker_command="$docker_command -t $IMAGE_VERSION ." 100 | # Running docker command 101 | echo "Building the docker image $IMAGE_VERSION" 102 | bash -c "$docker_command" 103 | 104 | echo "" 105 | echo "Done!" 106 | echo "" 107 | 108 | exit 0 109 | -------------------------------------------------------------------------------- /spark-standalone/Dockerfile: -------------------------------------------------------------------------------- 1 | ##################################################################################################### 2 | # ramtricks/spark-standalone Dockerfile 3 | # 4 | # This file prepares an environment for pySpark studies. It's not recommended you use this on 5 | # production environment. 6 | # 7 | # You can try another versions of Spark, Hadoop and Python since they're available in their 8 | # sources. To do that, edit the config.sh script. 9 | # 10 | # This works preparing a base container to run spark as master and worker. It's controlled 11 | # by start-spark.sh which is copyed into the container. Then, docker-compose rewrite the necessary 12 | # variables to start as 'master' or 'worker'. 13 | # 14 | # License: Artistic2 - This software is free and you can use, modify and distribute according with 15 | # terms of the license. 16 | # More details in https://opensource.org/license/artistic-2-0/ 17 | # 18 | ##################################################################################################### 19 | # Debian is the best! 20 | FROM debian:12.1 as builder 21 | # Getting arguments from docker build --build-args 22 | # All must be set on config.sh file if you're using build-image.sh script 23 | ARG SPARK_VERSION 24 | ARG HADOOP_VERSION 25 | ARG SPARK_HOME 26 | ARG PYTHON_VERSION 27 | ARG PYTHONHASHEED 28 | ARG SPARK_MASTER_PORT 29 | ARG SPARK_MASTER_WEBUI_PORT 30 | ARG SPARK_LOG_DIR 31 | ARG SPARK_MASTER_LOG 32 | ARG SPARK_WORKER_LOG 33 | ARG SPARK_WORKER_WEBUI_PORT 34 | ARG SPARK_WORKER_PORT 35 | ARG NEW_USER 36 | ARG NEW_USER_PASSWORD 37 | ARG JAVA_HOME 38 | 39 | ENV JAVA_HOME=$JAVA_HOME 40 | ENV SPARK_HOME=$SPARK_HOME 41 | 42 | # Copying spark/hadoop package from resources dir(local) to /(remote) 43 | # It's recommended you run build-image.sh script instead running Dockerfile directly. 44 | # But, If you want to run this Dockerfile directly, you'll need to download files bellow first. See build-image.sh 45 | # where you can find them 46 | COPY apache-spark.tgz / 47 | COPY python-"$PYTHON_VERSION".tgz / 48 | COPY openjdk11.tar.gz / 49 | # Necessary to stablish the environment 50 | COPY config.sh / 51 | COPY start-spark.sh / 52 | COPY project.sh / 53 | # Add Dependencies for PySpark 54 | RUN apt-get update && apt-get install -y curl vim wget software-properties-common ssh libssh-dev \ 55 | net-tools ca-certificates vim build-essential libffi-dev libncursesw5-dev libgdbm-dev libc6-dev \ 56 | zlib1g-dev libsqlite3-dev tk-dev libssl-dev openssl libbz2-dev 57 | # Installing the disgusting Java 11. OMG! 58 | RUN mkdir -p $JAVA_HOME 59 | RUN tar -xzvmf openjdk11.tar.gz -C $JAVA_HOME 60 | RUN mv $JAVA_HOME/jdk-11/* $JAVA_HOME 61 | RUN rm -rf $JAVA_HOME/jdk-11 62 | # Compiling Python 63 | RUN tar -xzvf /python-3.10.12.tgz && cd /Python-3.10.12 && ./configure && make && make install 64 | ## Installing alternative version of Python 65 | RUN update-alternatives --install "/usr/bin/python" "python" "$(which python3.10)" 0 66 | RUN update-alternatives --install "/usr/bin/pip" "pip" "$(which pip3.10)" 0 67 | # Fix the value of PYTHONHASHSEED 68 | # Note: this is needed when you use Python 3.3 or greater 69 | ENV PYTHONHASHSEED=1 70 | # Creating spark base dir into container 71 | RUN mkdir -p $SPARK_HOME 72 | RUN tar -xf /apache-spark.tgz -C $SPARK_HOME --strip-components=1 73 | RUN rm apache-spark.tgz 74 | # Apache spark environment 75 | FROM builder as apache-spark 76 | # Setup SPARK HOME 77 | WORKDIR $SPARK_HOME 78 | # Setting variables for master. They'll all replaced on docker-compose.yml 79 | ENV SPARK_MASTER_PORT=$SPARK_MASTER_PORT \ 80 | SPARK_MASTER_WEBUI_PORT=$SPARK_WORKER_WEBUI_PORT \ 81 | SPARK_LOG_DIR=$SPARK_HOME/logs \ 82 | SPARK_MASTER_LOG=$SPARK_HOME/logs/spark-master.out \ 83 | SPARK_WORKER_LOG=$SPARK_HOME/logs/spark-worker.out \ 84 | SPARK_WORKER_WEBUI_PORT=$SPARK_WORKER_WEBUI_PORT \ 85 | SPARK_WORKER_PORT=$SPARK_WORKER_PORT \ 86 | SPARK_MASTER=$SPARK_MASTER \ 87 | SPARK_WORKLOAD=$SPARK_WORKLOAD \ 88 | SPARK_HOME=$SPARK_HOME 89 | 90 | RUN mkdir -p $SPARK_LOG_DIR && \ 91 | touch $SPARK_MASTER_LOG && \ 92 | touch $SPARK_WORKER_LOG && \ 93 | ln -sf /dev/stdout $SPARK_MASTER_LOG && \ 94 | ln -sf /dev/stdout $SPARK_WORKER_LOG 95 | 96 | # Creating developer environment 97 | ENV DEV_HOME=/home/developer 98 | RUN useradd -md $DEV_HOME -s /usr/bin/bash ${NEW_USER} && echo "${NEW_USER}:${NEW_USER_PASSWORD}" | chpasswd 99 | RUN bash -c "mkdir -p $SPARK_HOME/work" 100 | # TODO Find a better solution for this. 101 | RUN bash -c "chmod 777 $SPARK_HOME/work" 102 | 103 | USER $NEW_USER 104 | WORKDIR $DEV_HOME 105 | RUN bash -c "mkdir -p $DEV_HOME/pyspark-apps/" 106 | COPY requirements.txt $DEV_HOME/ 107 | 108 | RUN bash -c "touch /home/developer/.bashrc" 109 | RUN bash -c "echo 'PATH=\$PATH:/home/\$NEW_USER/.local/bin:/opt/spark/bin' >> /home/developer/.bashrc" 110 | RUN bash -c "python3 -mpip install pip --upgrade" 111 | RUN bash -c "python3 -mpip install -r /home/developer/requirements.txt" 112 | 113 | # Exposing ports 114 | EXPOSE 8080 7077 6066 115 | 116 | # Starting master 117 | CMD ["/bin/bash", "/start-spark.sh"] 118 | -------------------------------------------------------------------------------- /spark-standalone/README.md: -------------------------------------------------------------------------------- 1 | # ramtricks/spark-standalone 2 | 3 | Basic environment for studies in pySpark 4 | 5 | 6 | # Version 7 | 0.0.4 8 | 9 | # Intro 10 | 11 | The information here allows Spark students and enthusiasts to have a basic environment 12 | for studying and test ideas based on PySpark API. 13 | 14 | # Features 15 | - Parametrized(customizable) config 16 | - Container based on Debian 12.1 stable 17 | - Python compiled from the source code 18 | - Default Spark version 3.4.2 19 | - Default Hadoop version 3.2 20 | 21 | # Requirements for this tutorial 22 | - Debian-based Linux distribution 23 | - Docker/docker-compose 24 | - Python >=3.7 **with virtualenv installed** 25 | 26 | 27 | --- 28 | 29 | 30 | # Not so "straight-forward install" 31 | 32 | ## Setup docker in your machine 33 | 34 | **If you already have Docker configured in your system, just jump to the next section!** 35 | 36 | You can find the Docker official instructions [here](https://docs.docker.com/engine/install/ubuntu/) 37 | 38 | Or follow my instructions, up to you! 39 | 40 | 41 | 1. Remove the default Docker packages of your system 42 | 43 | ```bash 44 | sudo apt purge docker.io docker-doc docker-compose podman-docker containerd runc 45 | ``` 46 | 47 | 2. Prepare your environment 48 | 49 | ```bash 50 | sudo apt update && sudo apt install -y ca-certificates curl gnupg 51 | ``` 52 | 53 | 3. Add the necessary keys for the Docker repos 54 | 55 | ```bash 56 | sudo install -m 0755 -d /etc/apt/keyrings \ 57 | curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg \ 58 | sudo chmod a+r /etc/apt/keyrings/docker.gpg 59 | ``` 60 | 61 | 4. Add the official Docker repositories 62 | 63 | ```bash 64 | echo \ 65 | "deb [arch="$(dpkg --print-architecture)" signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \ 66 | "$(. /etc/os-release && echo "$VERSION_CODENAME")" stable" | \ 67 | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null 68 | ``` 69 | 70 | 5. Finally, reinstall Docker 71 | 72 | ```bash 73 | sudo apt update \ 74 | sudo apt install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin 75 | ``` 76 | 77 | 6. Add your user into docker group. Why? Because there is no reason to be execute `sudo` to run Docker in your personal studying machine setup. 78 | 79 | ```bash 80 | sudo usermod -aG docker 81 | ``` 82 | 83 | 7. Reboot your machine(Yeah, I know! But, it's easier that way) 84 | 85 | 86 | 8. Check if docker it's working 87 | 88 | 89 | You can check if it's working running the command `docker --version`. If something is wrong, you're in trouble! 90 | Check your previous steps and try again! 91 | 92 | If the version appears with no errors, you're probably good! 93 | 94 | 95 | # Setup version of things and docker image build 96 | 97 | Open the file called `config.sh`. You should see this: 98 | 99 | ```bash 100 | # Loading project metadata 101 | source project.sh 102 | # Verison vars 103 | export SPARK_VERSION="3.2.4" 104 | export HADOOP_VERSION="3.2" 105 | export PYTHON_VERSION="3.10.12" 106 | # Docker Tag version 107 | export IMAGE_TAG="$PROJECT_VERSION" 108 | # System vars 109 | export TZ_STR=America/Sao_Paulo 110 | export NEW_USER="developer" 111 | export NEW_USER_PASSWORD="Dev#1842" 112 | # Spark config vars 113 | export SPARK_HOME=/opt/spark 114 | export SPARK_MASTER_PORT=7077 115 | export SPARK_WORKER_WEBUI_PORT=8080 116 | export SPARK_WORKER_PORT=7000 117 | # Java home in containers 118 | export JAVA_HOME=/opt/java 119 | # Docker no-cache option 120 | export DOCKER_NO_CACHE=1 121 | # Set ramtricks image tag name 122 | export IMAGE_VERSION="ramtricks/spark-stda-$SPARK_VERSION-hadoop-$HADOOP_VERSION-python-$PYTHON_VERSION:$IMAGE_TAG" 123 | 124 | ``` 125 | ### Python version 126 | **ATTENTION**: You need to keep in mind that Python version in your local machine must be the same version on Spark cluster. So, 127 | check out the local Python version first and change it on config.sh 128 | 129 | # Building the Docker image 130 | 131 | Finally, let's build it! 132 | 133 | `source config.sh && ./build-image.sh` 134 | 135 | # Up the container cluster 136 | 137 | Now, run the command: `source config.sh && docker-compose up` 138 | 139 | Don't worry about "warning" messages! 140 | 141 | You should see a line like this 142 | 143 | ```bash 144 | INFO MasterWebUI: Bound MasterWebUI to spark-master, and started at http://2f8eed8abb75:8080 145 | ``` 146 | 147 | You'll need the master id from this http address. In this case, 2f8eed8abb75. 148 | 149 | 150 | 151 | # Testing Spark 152 | 153 | * Run `docker ps -a` and check if you see something like this: 154 | 155 | ```bash 156 | CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 157 | 2190ae9a8d61 ramtricks/spark-standalone-spark3.0.2-hadoop-3.2:0.0.4 "/bin/bash /start-sp…" 2 hours ago Up 45 minutes 6066/tcp, 7077/tcp, 0.0.0.0:7000->7000/tcp, :::7000->7000/tcp, 0.0.0.0:9096->8080/tcp, :::9096->8080/tcp spark-standalone-spark-worker-a-1 158 | ca87b68ff332 ramtricks/spark-standalone-spark3.0.2-hadoop-3.2:0.0.4 "/bin/bash /start-sp…" 2 hours ago Up 45 minutes 6066/tcp, 7077/tcp, 0.0.0.0:7001->7000/tcp, :::7001->7000/tcp, 0.0.0.0:9097->8080/tcp, :::9097->8080/tcp spark-standalone-spark-worker-b-1 159 | 2b7ae5f206dc ramtricks/spark-standalone-spark3.0.2-hadoop-3.2:0.0.4 "/bin/bash /start-sp…" 2 hours ago Up 45 minutes 6066/tcp, 0.0.0.0:7077->7077/tcp, :::7077->7077/tcp, 0.0.0.0:9095->8080/tcp, :::9095->8080/tcp spark-standalone-spark-master-1 160 | 161 | 162 | ``` 163 | 164 | If you see any "Exited" word, that means the Spark service is off and something wrong happened. You'll have to check 165 | the screen log and check your steps again. 166 | 167 | 168 | * If everything is running, you can call pyspark using the id of the 'master' container for testing using the command 169 | 170 | `docker exec -it 2b7ae5f206dc bash -c "/opt/spark/current/bin/pyspark"` 171 | 172 | You should see something like this: 173 | 174 | ```text 175 | Python 3.7.3 (default, Jun 29 2023, 18:03:57) 176 | [GCC 8.3.0] on linux 177 | Type "help", "copyright", "credits" or "license" for more information. 178 | WARNING: An illegal reflective access operation has occurred 179 | WARNING: Illegal reflective access by org.apache.spark.unsafe.Platform (file:/opt/spark/3.0.2/jars/spark-unsafe_2.12-3.0.2.jar) to constructor java.nio.DirectByteBuffer(long,int) 180 | WARNING: Please consider reporting this to the maintainers of org.apache.spark.unsafe.Platform 181 | WARNING: Use --illegal-access=warn to enable warnings of further illegal reflective access operations 182 | WARNING: All illegal access operations will be denied in a future release 183 | 23/07/02 14:37:11 WARN NativeCodeLoader: Unable to load native-hadoop library for your platform... using builtin-java classes where applicable 184 | Using Spark's default log4j profile: org/apache/spark/log4j-defaults.properties 185 | Setting default log level to "WARN". 186 | To adjust logging level use sc.setLogLevel(newLevel). For SparkR, use setLogLevel(newLevel). 187 | Welcome to 188 | ____ __ 189 | / __/__ ___ _____/ /__ 190 | _\ \/ _ \/ _ `/ __/ '_/ 191 | /__ / .__/\_,_/_/ /_/\_\ version 3.2.4 192 | /_/ 193 | 194 | Using Python version 3.7.3 (default, Jun 29 2023 18:03:57) 195 | SparkSession available as 'spark'. 196 | ``` 197 | 198 | You're ready to go! 199 | 200 | 201 | # Setup and start Jupyter 202 | 203 | Go to the 'apps' directory and follow the steps below. 204 | 205 | 1. Create a virtualenv environment 206 | 207 | `python -mpip virtualenv venv` 208 | 209 | 2. Activate virtuaenv environment 210 | 211 | `source venv/bin/activate` 212 | 213 | 3. Create a requirements.txt file(dependencies file) 214 | 215 | ```txt 216 | pyspark==3.2.4 217 | numpy 218 | scikit-learn 219 | pandas==1.5.3 220 | polars 221 | jupyter 222 | jupyterlab 223 | pyarrow 224 | 225 | ``` 226 | 227 | 6. Install dependencies 228 | 229 | 230 | `python -mpip install -r requirements.txt` 231 | 232 | 233 | 7. Run `jupyter-lab` or `jupyter-notebook` 234 | 235 | 236 | 8. pySpark example application 237 | 238 | ```python 239 | # Importing libs 240 | import pyspark 241 | import pyspark.sql.functions as F 242 | from pyspark.sql import SparkSession 243 | from pyspark.sql.types import StructType, StructField, StringType 244 | 245 | # Remember the "master id"? You'll need it now! 246 | spark = SparkSession.builder \ 247 | .appName('test001').master("spark://127.0.0.1:7077")\ 248 | .getOrCreate() 249 | 250 | # Creating a basic schema 251 | schema = StructType([ 252 | StructField('target', StringType(), True) 253 | ]) 254 | # Let's order this string 255 | data = [['XADOWPQ']] 256 | df = spark.createDataFrame(data, schema) \ 257 | .withColumn('target', F.split('target','')) \ 258 | .withColumn('target', F.array_sort('target')) \ 259 | .withColumn('target', F.concat_ws('', 'target')) 260 | df.show() 261 | 262 | ``` 263 | 264 | The output must be this 265 | 266 | ```text 267 | +-------+ 268 | | target| 269 | +-------+ 270 | |ADOPQWX| 271 | +-------+ 272 | 273 | ``` 274 | 275 | If you see this, you're done! If don't, you need to review your steps and try again! 276 | 277 | 278 | # Future 279 | - Full automatic install 280 | 281 | 282 | # Bugs 283 | 284 | No bugtrack is defined yet. 285 | 286 | 287 | # Author 288 | 289 | [André Garcia Carneiro](mailto:andregarciacarneiro@gmail.com) 290 | 291 | 292 | # License 293 | 294 | Artistic2 295 | 296 | -------------------------------------------------------------------------------- /spark-standalone/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 | 635 | Copyright (C) 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 | Copyright (C) 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 | --------------------------------------------------------------------------------