Skip to content

Latest commit

 

History

History
170 lines (109 loc) · 4.26 KB

REFERENCE.md

File metadata and controls

170 lines (109 loc) · 4.26 KB
Raw

Reference

Table of Contents

Classes

Public Classes

  • superset: Superset main class that has parameters for customising the installation and configuration of Apache Superset lint:ignore:140chars lint:ign

Private Classes

  • superset::config: Manages the superset_config.py configuration file
  • superset::firewalld: Manages firewalld service and opens Superset port
  • superset::init_db: Initialises the superset db with an admin user, default roles and default permissions. Can also optionally load examples lint:ignore:140cha
  • superset::install: Creates the Superset user and configures a Python virtual environment for installing Apache Superset and its dependent Python libraries
  • superset::packages: Manages package dependencies for Superset
  • superset::postgresql: Manages a basic postgresql backend for superset
  • superset::python: Installs and configures the Python
  • superset::service: Configures and manages Superset service (using Gunicorn)

Classes

superset

Superset main class that has parameters for customising the installation and configuration of Apache Superset

lint:ignore:140chars

lint:ignore:parameter_order

Examples

include superset

Parameters

The following parameters are available in the superset class:

install_dir

Data type: String

The directory that a Python Virtual Environment will be created under and where Superset will be installed

port

Data type: Integer

The port that that superset will be served from. Default: 8088

user

Data type: String

The owner of any file/folders created for the Superset installation

load_examples

Data type: Boolean

Option for loading example charts and data. Default: false

manage_python

Data type: Boolean

Option for managing the installation of python. Default: true

manage_webserver

Data type: Boolean

Option for managing a gunicorn webserver. Default: true

manage_db

Data type: Boolean

Option for managing a Postgresql db back-end. Default: true

manage_firewall

Data type: Boolean

Option for managing firewall (RHEL8 firwalld). Default: false

admin_config

Data type: Hash

Overide option for superset admin user data (username, first name, last name, email, password). Default:

  • username: admin
  • password: password
gunicorn_config

Data type: Hash

Overide option for gunicorn. Default:

  • install_dir: "%{lookup('superset::install_dir')}"
  • workers: 10
  • timeout: 120
  • bind: "0.0.0.0:%{lookup('superset::port')}"
  • limit_request_line: 0
  • limit_request_field_size: 0
  • statsd_host: localhost:8125
app_config

Data type: Hash

Overide option for overiding the superset default configuration Available options include:

  • row_limit
  • superset_webserver_port
  • secret_key
  • sqlalchemy_database_uri
  • wtf_csrf_enabled
  • wtf_csrf_exempt_list
  • wtf_csrf_time_limit
  • mapbox_api_key
pgsql_config

Data type: Hash

Overide option for overiding the default postgresql configuration Available options include:

  • database
  • user
  • password
  • host
  • port
python_version

Data type: String

Overide option for setting the Python version if it will be managed by this module

db_drivers

Data type: Array[String]

Overide option for setting database drivers (python database driver packages) to be installed