├── .gitreview ├── templates ├── logrotate.conf.j2 ├── ara_service.conf.j2 ├── apache_mod_wsgi.conf.j2 └── nginx_embedded_proxy.conf.j2 ├── tasks ├── embedded │ └── standalone.yml ├── nginx │ ├── embedded_proxy.yml │ └── install.yml ├── apache │ └── mod_wsgi.yml ├── install │ └── pip.yml └── main.yml ├── example-playbooks ├── default.yml ├── mod_wsgi.yml └── nginx_embedded_proxy.yml ├── meta └── main.yml ├── vars ├── Debian.yml └── RedHat.yml ├── handlers └── main.yml ├── README.rst ├── defaults └── main.yml └── LICENSE /.gitreview: -------------------------------------------------------------------------------- 1 | [gerrit] 2 | host=review.openstack.org 3 | port=29418 4 | project=openstack/ansible-role-ara.git 5 | -------------------------------------------------------------------------------- /templates/logrotate.conf.j2: -------------------------------------------------------------------------------- 1 | {{ ara.config.logdir }}/*.log { 2 | rotate 14 3 | size 10M 4 | missingok 5 | compress 6 | copytruncate 7 | } 8 | -------------------------------------------------------------------------------- /templates/ara_service.conf.j2: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=ARA 3 | Documentation=https://github.com/openstack/ara 4 | After=network.target 5 | 6 | [Service] 7 | Type=simple 8 | TimeoutStartSec=0 9 | Restart=on-failure 10 | RestartSec=10 11 | RemainAfterExit=yes 12 | User=ara 13 | Group=ara 14 | Environment=ANSIBLE_CONFIG=/etc/ara/ara.cfg 15 | ExecStart={{ ara_manage.stdout }} runserver 16 | 17 | [Install] 18 | WantedBy=multi-user.target 19 | -------------------------------------------------------------------------------- /tasks/embedded/standalone.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) 2018 Red Hat, Inc. 3 | # 4 | # This file is part of ARA Records Ansible. 5 | # 6 | # ARA is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # ARA is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with ARA. If not, see . 18 | 19 | - name: Ensure the embedded server service is started and enabled 20 | become: true 21 | service: 22 | name: ara 23 | state: started 24 | enabled: yes 25 | -------------------------------------------------------------------------------- /templates/apache_mod_wsgi.conf.j2: -------------------------------------------------------------------------------- 1 | 2 | ServerName {{ ara.config.host }} 3 | 4 | ErrorLog {{ apache_log_path }}/ara-error.log 5 | LogLevel warn 6 | CustomLog {{ apache_log_path }}/ara-access.log combined 7 | 8 | SetEnv ANSIBLE_CONFIG /etc/ara/ara.cfg 9 | {% if ara.install.pip.virtualenv -%} 10 | SetEnv ARA_WSGI_USE_VIRTUALENV 1 11 | SetEnv ARA_WSGI_VIRTUALENV_PATH {{ ara.install.pip.virtualenv_path }} 12 | 13 | WSGIDaemonProcess ara user=ara group=ara processes=1 threads=4 python-home={{ ara.install.pip.virtualenv_path }} 14 | {% else -%} 15 | WSGIDaemonProcess ara user=ara group=ara processes=1 threads=4 16 | {% endif -%} 17 | WSGIScriptAlias {{ ara.config.application_root }} {{ wsgi_script }} 18 | WSGIProcessGroup ara 19 | WSGIApplicationGroup %{GLOBAL} 20 | 21 | 22 | 23 | Allow from all 24 | Satisfy Any 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /example-playbooks/default.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) 2018 Red Hat, Inc. 3 | # 4 | # This file is part of ARA Records Ansible. 5 | # 6 | # ARA is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # ARA is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with ARA. If not, see . 18 | 19 | # This runs the ARA role with default parameters on localhost. 20 | # It sets up ARA to run through the embedded webserver with a systemd unit file. 21 | - name: Install ARA with default settings 22 | hosts: localhost 23 | roles: 24 | - ara 25 | -------------------------------------------------------------------------------- /example-playbooks/mod_wsgi.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) 2018 Red Hat, Inc. 3 | # 4 | # This file is part of ARA Records Ansible. 5 | # 6 | # ARA is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # ARA is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with ARA. If not, see . 18 | 19 | # This runs the ARA role with parameters to set up apache with mod_wsgi. 20 | - name: Install ARA with mod_wsgi 21 | hosts: localhost 22 | vars: 23 | ara_override: 24 | deployment: 25 | server: apache 26 | type: mod_wsgi 27 | roles: 28 | - ara 29 | -------------------------------------------------------------------------------- /templates/nginx_embedded_proxy.conf.j2: -------------------------------------------------------------------------------- 1 | proxy_cache_path {{ ara.deployment.nginx.cache_directory }} levels=1:2 2 | keys_zone=ara:5m max_size=1g inactive=1d use_temp_path=off; 3 | 4 | upstream ara { 5 | server {{ ara.config.host }}:{{ ara.config.port }}; 6 | } 7 | 8 | server { 9 | listen {{ ara.config.proxy_port }}; 10 | server_name {{ ara.config.proxy_host }}; 11 | access_log /var/log/nginx/ara_access.log; 12 | error_log /var/log/nginx/ara_error.log; 13 | 14 | location {{ ara.config.application_root }} { 15 | # Define the location of the proxy server to send the request to 16 | proxy_pass http://ara; 17 | 18 | # Redefine the header fields that NGINX sends to the upstream server 19 | proxy_set_header Host $host; 20 | proxy_set_header X-Real-IP $remote_addr; 21 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 22 | 23 | proxy_cache ara; 24 | proxy_cache_revalidate on; 25 | proxy_cache_valid any 15m; 26 | proxy_cache_min_uses 1; 27 | proxy_cache_use_stale error timeout updating http_500 http_502 http_503 http_504; 28 | proxy_cache_background_update on; 29 | proxy_cache_lock on; 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /example-playbooks/nginx_embedded_proxy.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) 2018 Red Hat, Inc. 3 | # 4 | # This file is part of ARA Records Ansible. 5 | # 6 | # ARA is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # ARA is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with ARA. If not, see . 18 | 19 | # This runs the ARA role with parameters to set up nginx as a reverse proxy to 20 | # the embedded server. The web application will be available on '/ara'. 21 | - name: Install ARA with nginx as reverse proxy to the embedded server 22 | hosts: localhost 23 | vars: 24 | ara_override: 25 | config: 26 | application_root: /ara 27 | deployment: 28 | server: nginx 29 | type: embedded_proxy 30 | roles: 31 | - ara 32 | -------------------------------------------------------------------------------- /meta/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) 2018 Red Hat, Inc. 3 | # 4 | # This file is part of ARA Records Ansible. 5 | # 6 | # ARA is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # ARA is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with ARA. If not, see . 18 | 19 | galaxy_info: 20 | author: OpenStack community 21 | description: Installs and configure ARA 22 | company: Red Hat 23 | license: GPL v3 24 | min_ansible_version: 2.4 25 | platforms: 26 | - name: EL 27 | versions: 28 | - all 29 | - name: Fedora 30 | versions: 31 | - all 32 | - name: Ubuntu 33 | versions: 34 | - all 35 | - name: Debian 36 | versions: 37 | - all 38 | galaxy_tags: 39 | - installer 40 | - application 41 | - system 42 | dependencies: [] 43 | -------------------------------------------------------------------------------- /vars/Debian.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) 2018 Red Hat, Inc. 3 | # 4 | # This file is part of ARA Records Ansible. 5 | # 6 | # ARA is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # ARA is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with ARA. If not, see . 18 | 19 | required_packages: 20 | - gcc 21 | - libffi-dev 22 | - libssl-dev 23 | - libxml2-dev 24 | - libxslt-dev 25 | - python-dev 26 | - python-setuptools 27 | - python-virtualenv 28 | - debianutils 29 | 30 | required_wsgi_packages: 31 | - apache2 32 | - libapache2-mod-wsgi 33 | 34 | apache_service: apache2 35 | apache_user: www-data 36 | apache_group: www-data 37 | apache_log_path: /var/log/apache2 38 | apache_config_path: /etc/apache2/sites-available 39 | 40 | nginx_user: www-data 41 | nginx_group: www-data 42 | nginx_config_path: /etc/nginx/sites-available 43 | -------------------------------------------------------------------------------- /vars/RedHat.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) 2018 Red Hat, Inc. 3 | # 4 | # This file is part of ARA Records Ansible. 5 | # 6 | # ARA is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # ARA is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with ARA. If not, see . 18 | 19 | required_packages: 20 | - gcc 21 | - libffi-devel 22 | - libselinux-python 23 | - libxml2-devel 24 | - libxslt-devel 25 | - openssl-devel 26 | - python-devel 27 | - python-setuptools 28 | - python-virtualenv 29 | - redhat-rpm-config 30 | - which 31 | 32 | required_wsgi_packages: 33 | - httpd 34 | - mod_wsgi 35 | 36 | apache_service: httpd 37 | apache_user: apache 38 | apache_group: apache 39 | apache_log_path: /var/log/httpd 40 | apache_config_path: /etc/httpd/conf.d 41 | 42 | nginx_user: nginx 43 | nginx_group: nginx 44 | nginx_config_path: /etc/nginx/conf.d 45 | -------------------------------------------------------------------------------- /handlers/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) 2018 Red Hat, Inc. 3 | # 4 | # This file is part of ARA Records Ansible. 5 | # 6 | # ARA is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # ARA is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with ARA. If not, see . 18 | 19 | - name: reload systemctl daemon 20 | become: true 21 | systemd: 22 | daemon_reload: yes 23 | 24 | - name: restart apache 25 | become: true 26 | service: 27 | name: "{{ apache_service }}" 28 | state: restarted 29 | when: ara.deployment.server == 'apache' 30 | 31 | - name: restart nginx 32 | become: true 33 | service: 34 | name: nginx 35 | state: restarted 36 | when: ara.deployment.server == 'nginx' 37 | 38 | - name: restart ara 39 | become: true 40 | service: 41 | name: ara 42 | state: restarted 43 | when: ara.deployment.server == 'embedded' or 44 | ara.deployment.server == 'nginx' and ara.deployment.type == 'embedded_proxy' 45 | -------------------------------------------------------------------------------- /tasks/nginx/embedded_proxy.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) 2018 Red Hat, Inc. 3 | # 4 | # This file is part of ARA Records Ansible. 5 | # 6 | # ARA is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # ARA is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with ARA. If not, see . 18 | 19 | # We're setting ara.host to localhost, there's no point in making the web 20 | # application listen on 0.0.0.0 or other things since it'll be proxied by nginx 21 | - name: Override ARA host when reverse proxying 22 | vars: 23 | override: 24 | config: 25 | host: 127.0.0.1 26 | proxy_host: "{{ ara.config.host }}" 27 | proxy_port: 80 28 | set_fact: 29 | ara: "{{ ara | combine(override, recursive=true) }}" 30 | 31 | - name: Ensure the embedded server service is running 32 | include_tasks: ../embedded/standalone.yml 33 | 34 | - name: Set selinux boolean to allow nginx to reverse proxy 35 | become: yes 36 | seboolean: 37 | name: httpd_can_network_connect 38 | state: yes 39 | persistent: yes 40 | when: ansible_os_family == "RedHat" 41 | 42 | - name: Install nginx 43 | include_tasks: install.yml 44 | 45 | - name: Set up the nginx configuration 46 | template: 47 | src: nginx_embedded_proxy.conf.j2 48 | dest: "{{ nginx_config_path }}/ara.conf" 49 | notify: 50 | - restart nginx 51 | 52 | - name: Enable the nginx configuration on Debian-like systems 53 | file: 54 | src: "{{ nginx_config_path }}/ara.conf" 55 | dest: /etc/nginx/sites-enabled/ara.conf 56 | state: link 57 | when: ansible_os_family == 'Debian' 58 | notify: 59 | - restart nginx 60 | -------------------------------------------------------------------------------- /tasks/nginx/install.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) 2018 Red Hat, Inc. 3 | # 4 | # This file is part of ARA Records Ansible. 5 | # 6 | # ARA is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # ARA is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with ARA. If not, see . 18 | 19 | # This is designed to be as little invasive as possible since the user might 20 | # already be installing and configuring nginx. 21 | 22 | - when: ansible_os_family == 'RedHat' 23 | block: 24 | - name: Ensure EPEL is installed on RedHat distributions 25 | package: 26 | name: epel-release 27 | state: installed 28 | 29 | - name: Ensure the EPEL repository is enabled 30 | ini_file: 31 | path: /etc/yum.repos.d/epel.repo 32 | section: epel 33 | option: enabled 34 | value: 1 35 | register: epel_state 36 | 37 | - name: Install nginx 38 | package: 39 | name: nginx 40 | state: installed 41 | 42 | # We don't want to leave EPEL enabled if it was disabled to begin with 43 | - name: Disable EPEL on Red Hat distributions if it was disabled 44 | ini_file: 45 | path: /etc/yum.repos.d/epel.repo 46 | section: epel 47 | option: enabled 48 | value: 0 49 | when: 50 | - ansible_os_family == 'RedHat' 51 | - epel_state is changed 52 | 53 | - name: Ensure nginx is started and enabled 54 | service: 55 | name: nginx 56 | state: started 57 | enabled: yes 58 | 59 | - name: Create the nginx cache directory 60 | file: 61 | path: "{{ ara.deployment.nginx.cache_directory }}" 62 | state: directory 63 | owner: "{{ nginx_user }}" 64 | group: "{{ nginx_group }}" 65 | -------------------------------------------------------------------------------- /tasks/apache/mod_wsgi.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) 2018 Red Hat, Inc. 3 | # 4 | # This file is part of ARA Records Ansible. 5 | # 6 | # ARA is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # ARA is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with ARA. If not, see . 18 | 19 | - name: Ensure the embedded server service is not started and is disabled 20 | become: true 21 | systemd: 22 | name: ara 23 | state: stopped 24 | enabled: no 25 | masked: yes 26 | 27 | - name: Install required dependencies for mod_wsgi 28 | become: true 29 | package: 30 | name: "{{ required_wsgi_packages }}" 31 | state: "present" 32 | 33 | - name: Set selinux boolean to allow Apache to manage the files 34 | become: true 35 | seboolean: 36 | name: httpd_unified 37 | state: yes 38 | when: ansible_os_family == "RedHat" 39 | 40 | - name: Get the location of the WSGI script 41 | command: which ara-wsgi 42 | environment: 43 | PATH: "{{ path_with_virtualenv | default(omit) }}" 44 | register: wsgi_location 45 | changed_when: false 46 | 47 | - name: Set the location of the WSGI script 48 | set_fact: 49 | wsgi_script: "{{ wsgi_location.stdout }}" 50 | 51 | - name: Set up Apache configuration 52 | become: true 53 | template: 54 | src: apache_mod_wsgi.conf.j2 55 | dest: "{{ apache_config_path }}/ara.conf" 56 | owner: root 57 | group: root 58 | mode: 0644 59 | notify: 60 | - restart apache 61 | 62 | - name: Ensure Apache server is started 63 | become: true 64 | systemd: 65 | state: started 66 | name: "{{ apache_service }}" 67 | enabled: true 68 | 69 | - name: Ensure the configuration is enabled 70 | become: true 71 | command: a2ensite ara 72 | when: ansible_os_family == "Debian" 73 | notify: 74 | - restart apache 75 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | ansible-role-ara 2 | ================ 3 | 4 | Ansible role to install and configure ARA on Fedora, RHEL, Fedora as well as 5 | Debian and Ubuntu. 6 | 7 | ARA_ (Ansible Run Analysis) records Ansible_ Playbook runs seamlessly to make 8 | them easier to visualize, understand and troubleshoot. It integrates with 9 | Ansible wherever you run it. 10 | 11 | .. _ARA: https://github.com/openstack/ara 12 | .. _Ansible: https://www.ansible.com/ 13 | 14 | Note 15 | ---- 16 | 17 | Please note that this role is still a work in progress and in development. 18 | 19 | What the role does 20 | ------------------ 21 | 22 | By default, the role allows for the installation of ARA and the `configuration 23 | of Ansible`_ to leverage the ARA callback. 24 | It also allows for the configuration of the `different parameters`_ to customize 25 | the behavior of ARA. 26 | 27 | It provides installation and configuration of the web application under the 28 | `embedded webserver or apache+mod_wsgi`_. 29 | 30 | .. _configuration of Ansible: http://ara.readthedocs.io/en/latest/configuration.html#ansible 31 | .. _different parameters: http://ara.readthedocs.io/en/latest/configuration.html#ara 32 | .. _embedded webserver or apache+mod_wsgi: http://ara.readthedocs.io/en/latest/webserver.html 33 | 34 | Using the role 35 | -------------- 36 | 37 | The default parameters of the role will install ARA and configure a persistent 38 | systemd service to run the embedded development server:: 39 | 40 | mkdir roles 41 | git clone https://git.openstack.org/openstack/ansible-role-ara roles/ara 42 | cat << EOF > playbook.yml 43 | - name: Install ARA with default settings 44 | hosts: localhost 45 | roles: 46 | - ara 47 | EOF 48 | ansible-playbook playbook.yml 49 | 50 | For more configuration and deployment examples, please refer to the 51 | ``example-playbooks`` directory. 52 | 53 | Contributors 54 | ============ 55 | See contributors on GitHub_. 56 | 57 | .. _GitHub: https://github.com/openstack/ansible-role-ara/graphs/contributors 58 | 59 | Copyright 60 | ========= 61 | 62 | :: 63 | 64 | Copyright (c) 2018 Red Hat, Inc. 65 | 66 | ARA is free software: you can redistribute it and/or modify 67 | it under the terms of the GNU General Public License as published by 68 | the Free Software Foundation, either version 3 of the License, or 69 | (at your option) any later version. 70 | 71 | ARA is distributed in the hope that it will be useful, 72 | but WITHOUT ANY WARRANTY; without even the implied warranty of 73 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 74 | GNU General Public License for more details. 75 | 76 | You should have received a copy of the GNU General Public License 77 | along with ARA. If not, see . 78 | -------------------------------------------------------------------------------- /defaults/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) 2018 Red Hat, Inc. 3 | # 4 | # This file is part of ARA Records Ansible. 5 | # 6 | # ARA is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # ARA is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with ARA. If not, see . 18 | 19 | ara: 20 | install: 21 | # The method used to install ARA ('pip' or 'distribution') 22 | method: pip 23 | pip: 24 | # If ARA should be installed inside a virtualenv 25 | virtualenv: true 26 | # Location where the virtualenv should be installed 27 | virtualenv_path: /opt/ara-venv 28 | # Method to install ARA with pip ('pypi' or 'source') 29 | method: pypi 30 | # When installing from source, location of the repository 31 | # When installing from a source on the filesystem, only specify the path to the repository 32 | source: git+https://git.openstack.org/openstack/ara 33 | # When installing from pypi, version to install (ex: '0.15.0') 34 | # When installing from source, ref to the commit, tag or branch to install 35 | # Defaults to the latest version on PyPi or the master branch when installing from source 36 | version: 37 | config: 38 | # If pymysql or psycopg2 are found in the connection string, the role will install the necessary driver 39 | database: "sqlite:////var/lib/ara/ansible.sqlite" 40 | # Host to listen on for embedded server, apache or nginx 41 | host: 127.0.0.1 42 | # Port to listen on for embedded server or apache 43 | port: 9191 44 | # Root (or prefix) for the web application location 45 | application_root: / 46 | # Directory where files are stored by default 47 | dir: /var/lib/ara 48 | # Path to the logging configuration 49 | logconfig: /etc/ara/logging.yml 50 | # Path where logs are stored 51 | logdir: /var/log/ara 52 | # Name of the log file 53 | logfile: ara.log 54 | deployment: 55 | # Server (apache, embedded, nginx) 56 | server: embedded 57 | # Type (mod_wsgi, standalone, embedded-proxy, etc.) 58 | type: standalone 59 | nginx: 60 | # Where nginx will store the proxy cache 61 | cache_directory: /var/cache/nginx 62 | 63 | # You can use a variable called ara_override to use custom configuration 64 | # parameters. 65 | 66 | # ara_override: 67 | # config: 68 | # database: "mysql+pymysql://ara:password@localhost/ara" 69 | -------------------------------------------------------------------------------- /tasks/install/pip.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) 2018 Red Hat, Inc. 3 | # 4 | # This file is part of ARA Records Ansible. 5 | # 6 | # ARA is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # ARA is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with ARA. If not, see . 18 | 19 | - name: Install required dependencies 20 | become: true 21 | package: 22 | name: "{{ required_packages }}" 23 | state: "present" 24 | 25 | # Debian/Ubuntu has a package for python-pip, RHEL and CentOS do not. 26 | # TODO: Fedora actually has a package for python-pip. 27 | - name: Install pip for Red Hat distributions 28 | become: true 29 | easy_install: 30 | name: pip 31 | state: present 32 | 33 | # Need to make sure setuptools is up to date 34 | - name: Initialize virtualenv with up-to-date setuptools 35 | become: true 36 | pip: 37 | name: setuptools 38 | state: latest 39 | virtualenv: "{{ ara.install.pip.virtualenv_path }}" 40 | when: ara.install.pip.virtualenv | bool 41 | 42 | - name: Install ARA with pip 43 | become: true 44 | vars: 45 | # Manage that the 'version' argument doesn't work when installing from source 46 | pkg_name: | 47 | {%- if ara.install.pip.method == 'source' and ara.install.pip.version -%} 48 | {{- ara.install.pip.source }}@{{ ara.install.pip.version | default('master') -}} 49 | {%- else -%} 50 | ara 51 | {%- endif -%} 52 | pip: 53 | name: "{{ pkg_name }}" 54 | version: "{{ ara.install.pip.version | default(omit, True) }}" 55 | state: present 56 | virtualenv: "{{ ara.install.pip.virtualenv | bool | ternary(ara.install.pip.virtualenv_path, omit) }}" 57 | 58 | - name: Install pymysql with pip 59 | become: true 60 | pip: 61 | name: pymysql 62 | state: present 63 | virtualenv: "{{ ara.install.pip.virtualenv | bool | ternary(ara.install.pip.virtualenv_path, omit) }}" 64 | when: '"pymysql" in ara.config.database' 65 | 66 | - name: Install psycopg2 with pip 67 | become: true 68 | pip: 69 | name: psycopg2 70 | state: present 71 | virtualenv: "{{ ara.install.pip.virtualenv | bool | ternary(ara.install.pip.virtualenv_path, omit) }}" 72 | when: '"psycopg2" in ara.config.database' 73 | 74 | - name: Suffix the virtualenv bin directory to PATH 75 | set_fact: 76 | path_with_virtualenv: "{{ ara.install.pip.virtualenv_path }}/bin:{{ ansible_env.PATH }}" 77 | when: ara.install.pip.virtualenv | bool 78 | -------------------------------------------------------------------------------- /tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Copyright (c) 2018 Red Hat, Inc. 3 | # 4 | # This file is part of ARA Records Ansible. 5 | # 6 | # ARA is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # ARA is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with ARA. If not, see . 18 | 19 | - name: Include OS family/distribution specific variables 20 | include_vars: "{{ item }}" 21 | with_first_found: 22 | - "{{ ansible_distribution }}.yml" 23 | - "{{ ansible_os_family }}.yml" 24 | 25 | - name: Override default variables 26 | set_fact: 27 | ara: "{{ ara | combine(ara_override, recursive=true) }}" 28 | when: 29 | - ara_override is defined 30 | - ara_override is mapping 31 | 32 | - name: Include ARA installation 33 | include_tasks: "install/{{ ara.install.method }}.yml" 34 | 35 | - name: Create user for ARA 36 | become: true 37 | user: 38 | name: ara 39 | comment: User for ARA Records Ansible 40 | shell: /sbin/nologin 41 | home: /var/lib/ara 42 | 43 | - name: Create ARA directories 44 | become: true 45 | file: 46 | path: "{{ item }}" 47 | state: directory 48 | owner: ara 49 | group: ara 50 | mode: 0750 51 | with_items: 52 | - /var/log/ara 53 | - /var/lib/ara 54 | - /etc/ara 55 | 56 | - name: Setup ARA logrotate 57 | become: true 58 | template: 59 | src: logrotate.conf.j2 60 | dest: /etc/logrotate.d/ara 61 | 62 | - name: Get the location of ara-manage 63 | command: which ara-manage 64 | environment: 65 | PATH: "{{ path_with_virtualenv | default(omit) }}" 66 | register: ara_manage 67 | changed_when: false 68 | 69 | - name: Copy systemd service template 70 | become: true 71 | template: 72 | src: templates/ara_service.conf.j2 73 | dest: /etc/systemd/system/ara.service 74 | owner: root 75 | group: root 76 | mode: 0644 77 | notify: 78 | - reload systemctl daemon 79 | - restart ara 80 | 81 | - name: Flush handlers 82 | meta: flush_handlers 83 | 84 | - name: Include web server configuration 85 | include_tasks: "{{ ara.deployment.server }}/{{ ara.deployment.type }}.yml" 86 | 87 | - name: Create the ARA configuration file 88 | become: true 89 | ini_file: 90 | path: /etc/ara/ara.cfg 91 | section: ara 92 | option: "{{ item.key }}" 93 | value: "{{ item.value }}" 94 | create: yes 95 | owner: ara 96 | group: ara 97 | mode: 0640 98 | with_dict: "{{ ara.config }}" 99 | notify: 100 | - restart ara 101 | - restart nginx 102 | 103 | - name: Get ARA's installed location 104 | command: python -m ara.setup.path 105 | environment: 106 | PATH: "{{ path_with_virtualenv | default(omit) }}" 107 | register: ara_location 108 | changed_when: false 109 | 110 | - name: Enable ARA Ansible configuration 111 | become: true 112 | ini_file: 113 | dest: /etc/ara/ara.cfg 114 | section: defaults 115 | option: "{{ item.option }}" 116 | value: "{{ item.value }}" 117 | with_items: 118 | - { option: local_tmp, value: /var/lib/ara/.ansible/ } 119 | - { option: callback_plugins, value: "{{ ara_location.stdout }}/plugins/callbacks" } 120 | - { option: action_plugins, value: "{{ ara_location.stdout }}/plugins/actions" } 121 | 122 | - name: Dump the role configuration 123 | become: true 124 | copy: 125 | dest: /etc/ara/ansible-role-ara.yml 126 | content: | 127 | {{ ara | to_nice_yaml(indent=4) }} 128 | {% if ara_override is defined -%} 129 | {{ ara_override | to_nice_yaml(indent=4) }} 130 | {% endif -%} 131 | owner: ara 132 | group: ara 133 | mode: 0640 134 | 135 | - name: Set the web application URL 136 | set_fact: 137 | webapp_url: "http://{{ ara.config.host_proxy | default(ara.config.host) }}:{{ ara.config.port_proxy | default(ara.config.port) }}" 138 | 139 | - name: Provide web application URL 140 | vars: 141 | msg: >- 142 | ARA was installed successfully ! 143 | The web application should now be reachable at the following address: 144 | {{ webapp_url }} 145 | debug: 146 | msg: "{{ msg.split('\n') }}" 147 | 148 | - name: Provide instructions 149 | vars: 150 | msg: >- 151 | You can find the configuration that was used for the execution of this role in /etc/ara/ansible-role-ara.yml. 152 | You can edit the configuration and re-run your ansible-playbook command with "--extra-vars @/etc/ara/ansible-role-ara.yml". 153 | 154 | A configuration file for Ansible and ARA was set up automatically in /etc/ara/ara.cfg. 155 | The ARA service is already using this configuration file but you'll need to make sure Ansible is using it so that Ansible knows where ARA is located. 156 | 157 | This can be done by exporting the ANSIBLE_CONFIG environment variable, like so: 158 | $ export ANSIBLE_CONFIG=/etc/ara/ara.cfg 159 | $ ansible-playbook playbook.yml 160 | 161 | Data from recorded playbooks will be available in the interface as soon as you run your first ansible-playbook command. 162 | debug: 163 | msg: "{{ msg.split('\n') }}" 164 | -------------------------------------------------------------------------------- /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 | . --------------------------------------------------------------------------------