Like what you see? Have a play with our trial version.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Configuration Item 

Description 

Example 

JDBC Driver Name, JDBC_CLASS_NAME 

Configure the JDBC Driver Class for connecting to the Yellowfin Repository (Required) 

-e JDBC_CLASS_NAME=org.postgresql.Driver 

Repository URL, JDBC_CONN_URL 

Specify the Connection URL to the Repository Database (Required) 

-e JDBC_CONN_URL=jdbc:postgresql://host:5432/yf 

Repository Username, JDBC_CONN_USER 

Specify the Database User required to access the Repository Database (Required) 

-e JDBC_CONN_USER=dba 

Repository Password, JDBC_CONN_PASS 

Specify the Database Password required to access the Repository Database. This can be encrypted. (Required) 

-e JDBC_CONN_PASS=secret 

Application Memory, APP_MEMORY 

Specify the number of megabytes of memory to be assigned to the Yellowfin application. If unset, Yellowfin will use the Java default (usually 25% of System RAM) 

-e APP_MEMORY=4096 

DB Password Encrypted, JDBC_CONN_ENCRYPTED 

Specify whether the Database Password is encrypted (true/false) 

-e JDBC_CONN_ENCRYPTED=true 

Connection Pool Size, JDBC_MAX_COUNT 

Specify the maximum size of the Repository Database connection pool. (Default: 25) 

-e JDBC_MAX_COUNT=25 

Default Welcome Page, WELCOME_PAGE 

Specify the default index page. 

-e WELCOME_PAGE=custom_index.jsp 

Internal Application HTTP Port 

Specify the internal HTTP port. (Default: 8080) 

-e APP_SERVER_PORT=9090 

Internal Shutdown Port 

Specify the internal shutdown port. (Default: 8083) 

-e TCP_PORT=9093 

Proxy Port, PROXY_PORT 

External Proxy Port 

-e PROXY_PORT=443 

Proxy Scheme, PROXY_SCHEME 

External Proxy Scheme (http/https) 

-e PROXY_SCHEME=https 

Proxy Host, PROXY_HOST 

External Proxy Host or IP address 

-e PROXY_HOST=reporting.company.com 

External Cluster Address, CLUSTER_ADDRESS 

External Cluster Address for Cluster Messaging. Usually the host or IP address of the Docker Host, or for Docker Swarm and Kubernetes, the DNS name of the container. 

-e CLUSTER_ADDRESS=10.10.10.23 

External Cluster Port, CLUSTER_PORT 

A Unique TCP port for this container to receive Cluster Messages from other nodes 

-e CLUSTER_ADDRESS=7801 

Internal Cluster Network Adapter, CLUSTER_INTERFACE 

Specify the docker interface to bind Cluster Messages to. Defaults to eth0, but this may need to be changed for Kubernetes and Docker Swarm 

-e CLUSTER_INTERFACE=match-interface:eth1 

 

Background Processing Task Types, NODE_BACKGROUND_TASKS 

Comma separated list of which background Task Types can be run on this node. NODE_PARALLEL_TASKS must also be updated if this item is specified. If unspecified, all Task Types will be enabled. 

-e NODE_BACKGROUND_TASKS= FILTER_CACHE,ETL_PROCESS_TASK 

Background Task Processing Jobs, NODE_PARALLEL_TASKS 

Comma separated list of the number of concurrent tasks for each Task Type that can be run on this node. The number of elements passed here must match the number of Task Types passed by NODE_BACKGROUND_TASKS 

-e NODE_PARALLEL_TASKS=5,4 

Additional Libraries URL, LIBRARY_ZIP 

URL to a Zip file that contains additional libraries to be extracted into lib folder of Yellowfin. This can be used to add additional JDBC drivers or custom plugins to Yellowfin. Make sure that the path is not included with zip entries in the archive. 

-e LIBRARY_ZIP=http://lib-host/libraries.zip 

 

horizontalrule
 
Anchor
image-download
image-download

Styleclass
ClasstopLink

top

...

Yellowfin image downloads Yellowfin image downloads and builds 

Yellowfin is available for download in a variety of formats.  

...

Note
We highly recommend you use a specific version number rather than ‘latest’ when pulling the App-Only image to avoid accidental updates during start-up. 

horizontalrule



Styleclass
ClasstopLink

61898760top

...

Deployment examples

The steps we’ve written for each type of containerized deployment should work for all major cloud providers, as well as on-premises environments.  

...