osp-front-end
Overview
The front-end module is responsible for serving static web content, to promote HTTP to HTTPS transport and proxy calls to other modules.
By default the stack is hosted via a self-generated HTTPS certificate pointing to hostname configured on the stack.
List of configuration files
Note
The module osp-front-end has no configuration file
Environment Variables
All modules env variables
Variable Name |
Default Value |
Usage |
|---|---|---|
PROMETHEUS_PORT |
9100 |
The internal port used for Openmetrics exposition. |
DISPATCHER_HOST |
modules_configuration-dispatcher_main |
The hostname on which the modules can fetch the configuration. |
DISPATCHER_PORT |
10000 |
The port used by the module to listen for configuration request. |
USE_LEGACY_RESTART |
Not set |
When this flag is enabled, the container will terminate itself whenever a restart is needed (for example, after a configuration change). This is the legacy restart (before version 2.1.0). Otherwise, the system will simply restart the process running inside the container. |
CUSTOM_JVM_OPTIONS |
Not set |
Allow to inject JVM options. See Configuration changes for more information. |
ALLOW_VERSION_MISMATCH |
Not set |
Allow to disable the version check when a new configuration is published to a module. By default, a module will not be restarted if its configuration does not match its version. |
Dedicated variables
Variable name |
Default value |
Usage |
|---|---|---|
NGINX_WORKER_PROCESS |
4 |
Process number given to NGINX to serve web content |
NGINX_WORKER_CONNECTION |
1024 |
The port on which modules can fetch the configuration |
SSL_CERTIFICATE |
${{auto-generated-ssl-certificate}} |
Swarm secret SSL certificate file path |
SSL_CERTIFICATE_KEY |
${{auto-generated-ssl-certificate-key}} |
Swarm secret SSL certificate key file path |
SSL_ADDITIONAL_PROTOCOLS |
Additional SSL protocols to TLSv1.3 (valid value include SSLv2, SSLv3, TLSv1, TLSv1.1 and TLSv1.2) |
|
APPLICATION_EXTERNAL_PORT |
5000 |
External port exposed by the stack |
KEYCLOAK_EXTERNAL_URL |
http://osp-keycloak:8080/auth |
External Keycloak (in swarm or hosted) IP address or host to forward proxy calls to |
KEYCLOAK_URL |
/auth |
Keycloak prefix to use on proxy to forward calls to external Keycloak |
KEYCLOAK_REALM |
OnSphere |
Keycloak realm to use |
KEYCLOAK_CLIENT_ID |
dashboard |
Keycloak client ID the front-end will use to announce itself |
ALLOW_ADMIN_ACCESS |
true |
Allow the access to the keycloak administration console with <stack-host-and-port>/auth/admin and rabbit management. |
RABBIT_URL_PREFIX |
/rabbit |
Allow to set the management prefix to access the rabbit management. |
NGINX_RESOLVER |
127.0.0.11 |
Let the user override Nginx’s default DNS resolver. This is useful to resolve correctly when in swarm mode, Kubernetes, Openshift or when using a custom DNS server. The default value is the swarm (docker) DNS server. |
BACKEND_WEB_HOSTNAME |
backend-web |
Normally this value is not needed, but if you change the network web alias in the module.service file, you need to set this variable to the new value. This variable is used to access the backend web service from the front-end module. The port used is the 5000 defined by module. |
BACKEND_GRAFANA_HOSTNAME |
osp-grafana |
This define if the grafana module is used in the stack. If you change the network web alias in the module.service file, you need to set this variable to the new value. This variable is used to access the backend grafana service from the front-end module to display grafana dashboards. If you use K8 setup you need to add the namespace in the name of the service. For example: |
STORAGE_API_MAX_BODY_SIZE |
5M |
Allow to set |