README.md

HSDP Apache Superset module

This module deploys Apache Superset on Container Host. It also deploys a Caddy based reverse proxy on Cloud foundry so you can access the Apache Superset UI.

Disclaimer

Important

This repository is managed as Philips Inner-source / Open-source. This repository is NOT endorsed or supported by HSSA&P or I&S Cloud Operations. You are expected to self-support or raise tickets on the Github project and NOT raise tickets in HSP ServiceNow.

Requirements

Name	Version
hsdp	>= 0.26.3

Providers

Name	Version
cloudfoundry	0.14.2
hsdp	0.26.3
random	3.1.0

Modules

Name	Source	Version
postgres	philips-labs/postgres-service/hsdp	n/a
redis	philips-labs/redis-service/hsdp	0.2.0

Resources

Name	Type
cloudfoundry_app.superset_proxy	resource
cloudfoundry_route.superset_proxy	resource
hsdp_container_host.superset	resource
random_id.id	resource
cloudfoundry_domain.domain	data source
cloudfoundry_org.org	data source
cloudfoundry_service.db	data source
cloudfoundry_service.redis	data source
cloudfoundry_space.space	data source
hsdp_config.cf	data source
hsdp_config.logging	data source

Inputs

Name	Description	Type	Default	Required
agent	Use SSH agent for authentication	bool	false	no
caddy_image	Caddy server image to use	string	"caddy:2.4.5"	no
cartel_secret	The Cartel secret to use for autoscaling	string	""	no
cartel_token	The Cartel token to use for autoscaling	string	""	no
docker_password	Docker registry password	string	""	no
docker_username	Docker registry username	string	""	no
fluent_bit_image	Fluent-bit image	string	"philipssoftware/fluent-bit-out-hsdp:latest"	no
hsdp_custom_field	Post structured JSON message to HSDP Logging custom field	string	"true"	no
hsdp_environment	The HSDP environment of the deployment	string	"client-test"	no
hsdp_product_key	HSDP Logging product key	string	""	no
hsdp_region	The HSDP region of the deployment	string	"us-east"	no
hsdp_secret_key	HSDP Logging secret key	string	""	no
hsdp_shared_key	HSDP Logging shared key	string	""	no
instance_type	The instance type to use	string	"t2.medium"	no
name_postfix	The postfix string to append to the hostname, prevents namespace clashes	string	""	no
org_name	Cloudfoundry ORG name to use for reverse proxy	string	n/a	yes
postgres_plan	The HSDP-RDS PostgreSQL plan to use	string	"postgres-medium-dev"	no
private_key	Private key for SSH access (should not have a passphrase)	string	""	no
redis_plan	The Redis plan to use	string	"redis-standalone"	no
space_name	Cloudfoundry SPACE name to use for reverse proxy	string	n/a	yes
superset_image	The Temporal server image to use	string	"apache/superset:latest-dev"	no
user	LDAP user to use for connections	string	n/a	yes
user_groups	User groups to assign to cluster	list(string)	n/a	yes
volume_size	The volume size to use in GB	number	50	no
worker_instance_type	Instance type of worker nodes	string	"m5.xlarge"	no
workers	Number of worker nodes to spin up	number	1	no

Outputs

Name	Description
superset_id	Server ID of Superset
superset_ip	Private IP address of Superset server
superset_proxy_endpoint	URL of the Superset proxy

Contact / Getting help

Please post your questions on the HSDP Slack #terraform channel

License

License is MIT

Requirements

Name	Version
hsdp	>= 0.26.3
ssh	>= 2.1.0

Providers

Name	Version
cloudfoundry	0.14.2
hsdp	0.26.3
random	3.1.0
ssh	2.1.0

Modules

Name	Source	Version
postgres	philips-labs/postgres-service/hsdp	n/a
redis	philips-labs/redis-service/hsdp	0.2.0

Resources

Name	Type
cloudfoundry_app.superset_proxy	resource
cloudfoundry_route.superset_proxy	resource
hsdp_container_host.superset	resource
random_id.id	resource
ssh_resource.server	resource
ssh_resource.server_volumes	resource
ssh_resource.worker	resource
cloudfoundry_domain.domain	data source
cloudfoundry_org.org	data source
cloudfoundry_service.db	data source
cloudfoundry_service.redis	data source
cloudfoundry_space.space	data source
hsdp_config.cf	data source
hsdp_config.logging	data source

Inputs

Name	Description	Type	Default	Required
agent	Use SSH agent for authentication	bool	false	no
caddy_image	Caddy server image to use	string	"caddy:2.4.5"	no
cartel_secret	The Cartel secret to use for autoscaling	string	""	no
cartel_token	The Cartel token to use for autoscaling	string	""	no
docker_password	Docker registry password	string	""	no
docker_username	Docker registry username	string	""	no
fluent_bit_image	Fluent-bit image	string	"philipssoftware/fluent-bit-out-hsdp:latest"	no
hsdp_custom_field	Post structured JSON message to HSDP Logging custom field	string	"true"	no
hsdp_environment	The HSDP environment of the deployment	string	"client-test"	no
hsdp_product_key	HSDP Logging product key	string	""	no
hsdp_region	The HSDP region of the deployment	string	"us-east"	no
hsdp_secret_key	HSDP Logging secret key	string	""	no
hsdp_shared_key	HSDP Logging shared key	string	""	no
instance_type	The instance type to use	string	"t2.medium"	no
name_postfix	The postfix string to append to the hostname, prevents namespace clashes	string	""	no
org_name	Cloudfoundry ORG name to use for reverse proxy	string	n/a	yes
postgres_plan	The HSDP-RDS PostgreSQL plan to use	string	"postgres-medium-dev"	no
private_key	Private key for SSH access (should not have a passphrase)	string	""	no
redis_plan	The Redis plan to use	string	"redis-standalone"	no
space_name	Cloudfoundry SPACE name to use for reverse proxy	string	n/a	yes
superset_image	The Temporal server image to use	string	"apache/superset:latest-dev"	no
user	LDAP user to use for connections	string	n/a	yes
user_groups	User groups to assign to cluster	list(string)	n/a	yes
volume_size	The volume size to use in GB	number	50	no
worker_instance_type	Instance type of worker nodes	string	"m5.xlarge"	no
workers	Number of worker nodes to spin up	number	1	no

Outputs

Name	Description
superset_id	Server ID of Superset
superset_ip	Private IP address of Superset server
superset_proxy_endpoint	URL of the Superset proxy