Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/idealista/superset_role
Ansible role to install Apache Superset
https://github.com/idealista/superset_role
ansible ansible-role debian superset
Last synced: about 2 months ago
JSON representation
Ansible role to install Apache Superset
- Host: GitHub
- URL: https://github.com/idealista/superset_role
- Owner: idealista
- License: apache-2.0
- Created: 2020-10-15T10:41:35.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-17T07:31:25.000Z (over 2 years ago)
- Last Synced: 2023-03-05T18:39:00.290Z (almost 2 years ago)
- Topics: ansible, ansible-role, debian, superset
- Language: YAML
- Homepage:
- Size: 142 KB
- Stars: 1
- Watchers: 12
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Apache Superset Ansible role
[](https://travis-ci.org/idealista/superset_role) [](https://galaxy.ansible.com/idealista/superset_role)
This ansible role installs [Superset](https://superset.apache.org/) in a Debian environment. It has been tested for Debian buster.
This role has been generated using the [cookiecutter](https://github.com/cookiecutter/cookiecutter) tool, you can generate a similar role that fits your needs using the this [cookiecutter template](https://github.com/idealista/cookiecutter-ansible-role).
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites-ballot_box_with_check)
- [Installing](#Installing-inbox_tray )
- [Usage](#usage-runner)
- [Testing](#testing-test_tube)
- [Built With](#built-with-building_construction)
- [Versioning](#versioning-card_file_box)
- [Authors](#authors-superhero)
- [License](#license-spiral_notepad)
- [Contributing](#contributing-construction_worker)
## Getting Started
These instructions will get you a copy of the role for your Ansible playbook. Once launched, it will install [Apache Superset](https://superset.apache.org/) in a Debian system.
### Prerequisites :ballot_box_with_check:
Ansible 2.9.x.x version installed.
Inventory destination should be a Debian (preferable Debian 10 Buster ) or Ubuntu environment.
âšī¸ By default this role use the predefined installation of Python that comes with the distro.
For testing purposes, [Molecule](https://molecule.readthedocs.io/) with [Docker](https://www.docker.com/) as driver and [Goss]() as verifier.
### Installing :inbox_tray:
Create or add to your roles dependency file (e.g requirements.yml):
```yml
- src: idealista.superset_role
scm: git
version: 1.1.0
name: superset_role
```
Install the role with ansible-galaxy command:
```sh
ansible-galaxy install -p roles -r requirements.yml -f
```
Use in a playbook:
```yml
---
- hosts: someserver
roles:
- role: superset_role
```
## Usage :runner:
Look to the defaults properties files to see the possible configuration properties, take a look for them:
- [`main.yml`](./defaults/main/main.yml) for superset general purpose vars.
- [`superset_config.yml`](./defaults/main/superset_config.yml) for all the related superset_config.py config parameters.
đ Don't forget :
- đĻ¸ To set your Admin user.
- đ To set Secret key.
- đ To set webserver secret key.
- đ To set your SUPERSET_HOME and SUPERSET_CONFIG_PATH at your own discretion.
- đ To set your installation and config skelton paths at your own discretion.
- đ See `superset_skeleton_paths` in [`main.yml`](./defaults/main/main.yml)
- âī¸ To customize your app service and superset running config.
- âī¸ To customize your feature flags.
- âī¸ To choose your preferred webdriver version in case of use [alerts & reports](https://superset.apache.org/docs/installation/alerts-reports) for example.
- đ Python and pip version, and install before if necessary.
- đ [Custom db drivers](#blue_car-Custom-db-drivers) In addition, superset requires additional drivers to connect to different databases [Supported Databases and Dependecies](https://superset.apache.org/docs/databases/installing-database-drivers).
- đĻ [Additional Python packages](#package-Additional-Python-packages) with version specific like like python-ldap for example to use LDAP login
### :blue_car: Custom db drivers
Choose yours editing the [`superset_db_drivers`](./defaults/main/main.yml) variable, you can see all the default db drivers ready to use (uncomment) in [`main-yml`](./defaults/main/main.yml). It should be a list like this:
```yml
superset_db_drivers:
- name: ClickHouse
package:
- name: clickhouse-driver
version: 0.2.0
- name: clickhouse-sqlalchemy
version: 0.1.6
- name: MySQL
package:
- name: mysqlclient
required_libs:
- default-libmysqlclient-dev
- python-mysqldb
- name: PostgreSQL
package:
- name: psycopg2-binary
```
### :package: Additional Python packages
[`superset_additional_python_packages`](./defaults/main/main.yml) should be a list following this format:
```yml
superset_additional_python_packages:
# [ LDAP ]
- name: python-ldap
```
## Testing :test_tube:
### Install dependencies
```sh
pipenv install -r test-requirements.txt
```
For more information read the [pipenv docs](ipenv-fork.readthedocs.io/en/latest/).
### Run test
```sh
pipenv run molecule test
```
## Built With :building_construction:
## Versioning :card_file_box:
For the versions available, see the [tags on this repository](https://github.com/idealista/superset_role/tags).
Additionaly you can see what change in each version in the [CHANGELOG.md](CHANGELOG.md) file.
## Authors :superhero:
- **Idealista** - *Work with* - [idealista](https://github.com/idealista)
See also the list of [contributors](https://github.com/idealista/superset_role/contributors) who participated in this project.
## License :spiral_notepad:
This project is licensed under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license - see the [LICENSE](LICENSE) file for details.
## Contributing :construction_worker:
Please read [CONTRIBUTING.md](.github/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.