Platform gateway variables

envoy_disable_https

Controls whether or not HTTPS is disabled when accessing the platform UI. Set to true to disable HTTPS (HTTP is used instead).

Optional

false.

envoy_http_port

Port number on which the Envoy proxy listens for incoming HTTP connections.

Optional

80

envoy_https_port

Port number on which the Envoy proxy listens for incoming HTTPS connections.

Optional

443

gateway_admin_email

Email address used by Django for the admin user for platform gateway.

Optional

admin@example.com

gateway_admin_password

Platform gateway administrator password. Use of special characters for this variable is limited. The password can include any printable ASCII character except /, ", or @.

Required

gateway_admin_user

Username used to identify and create the administrator user in platform gateway.

Optional

admin

gateway_control_plane_port

Port number for the platform gateway control plane.

Optional

50051

gateway_extra_settings

Defines additional settings for use by platform gateway during installation.

For example:

gateway_extra_settings=[{"setting": "OAUTH2_PROVIDER['ACCESS_TOKEN_EXPIRE_SECONDS']", "value": 600}]

Optional

[]

gateway_grpc_auth_service_timeout

Timeout duration (in seconds) for requests made to the gRPC service on platform gateway.

Optional

30s

gateway_grpc_server_max_threads_per_process

Maximum number of threads that each gRPC server process can create to handle requests on platform gateway.

Optional

10

gateway_grpc_server_processes

Number of processes for handling gRPC requests on platform gateway.

Optional

5

gateway_main_url

URL of the main instance of platform gateway that clients connect to. Use if you are performing a clustered deployment and you need to use the URL of the load balancer instead of the component's server. The URL must start with http:// or https:// prefix.

Optional

gateway_nginx_client_max_body_size

Maximum allowed size for data sent to platform gateway through NGINX.

Optional

5m

gateway_nginx_disable_hsts

Controls whether HTTP Strict Transport Security (HSTS) is enabled or disabled for platform gateway. Set this variable to true to disable HSTS.

Optional

false

gateway_nginx_disable_https

Controls whether HTTPS is enabled or disabled for platform gateway. Set this variable to true to disable HTTPS.

Optional

false

gateway_nginx_hsts_max_age

Maximum duration (in seconds) that HTTP Strict Transport Security (HSTS) is enforced for platform gateway.

Optional

63072000

gateway_nginx_http_port

Port number that platform gateway listens on for HTTP requests.

Optional

8083

gateway_nginx_https_port

Port number that platform gateway listens on for HTTPS requests.

Optional

8446

gateway_nginx_https_protocols

Protocols that platform gateway will support when handling HTTPS traffic.

Optional

[TLSv1.2, TLSv1.3]

gateway_nginx_user_headers

List of additional NGINX headers to add to platform gateway's NGINX configuration.

Optional

[]

gateway_pg_cert_auth

Controls whether client certificate authentication is enabled or disabled on the platform gateway PostgreSQL database. Set this variable to true to enable client certificate authentication.

Optional

false

gateway_pg_database

Name of the PostgreSQL database used by platform gateway.

Optional

gateway

gateway_pg_host

Hostname of the PostgreSQL database used by platform gateway.

Required

gateway_pg_password

Password for the platform gateway PostgreSQL database user. Use of special characters for this variable is limited. The !, #, 0 and @ characters are supported. Use of other special characters can cause the setup to fail.

Optional

gateway_pg_port

Port number for the PostgreSQL database used by platform gateway.

Optional

5432

gateway_pg_sslmode

Controls the SSL mode to use when platform gateway connects to the PostgreSQL database. Valid options include verify-full, verify-ca, require, prefer, allow, disable.

Optional

prefer

gateway_pg_tls_cert

Path to the PostgreSQL SSL/TLS certificate file for platform gateway.

Required if using client certificate authentication.

gateway_pg_tls_key

Path to the PostgreSQL SSL/TLS key file for platform gateway.

Required if using client certificate authentication.

gateway_pg_username

Username for the platform gateway PostgreSQL database user.

Optional

gateway

gateway_proxy_firewall_zone

The firewall zone where platform gateway related firewall rules are applied. This controls which networks can access platform gateway based on the zone's trust level.

Optional

public

gateway_redis_disable_tls

Controls whether TLS is enabled or disabled for platform gateway Redis. Set this variable to true to disable TLS.

Optional

false

gateway_redis_host

Hostname of the Redis host used by platform gateway.

Optional

First node in the [automationgateway] inventory group.

gateway_redis_password

Password for platform gateway Redis.

Optional

Randomly generated string.

gateway_redis_port

Port number for the Redis host for platform gateway.

Optional

6379

gateway_redis_tls_cert

Path to the platform gateway Redis certificate file.

Optional

gateway_redis_tls_key

Path to the platform gateway Redis key file.

Optional

gateway_redis_username

Username for platform gateway Redis.

Optional

gateway

gateway_secret_key

Secret key value used by platform gateway to sign and encrypt data.

Optional

gateway_tls_cert

Path to the SSL/TLS certificate file for platform gateway.

Optional

gateway_tls_key

Path to the SSL/TLS key file for platform gateway.

Optional

gateway_tls_remote

Denote whether the platform gateway provided certificate files are local to the installation program (false) or on the remote component server (true).

Optional

false

gateway_use_archive_compression

Controls whether archive compression is enabled or disabled for platform gateway. You can control this functionality globally by using use_archive_compression.

Optional

true

gateway_use_db_compression

Controls whether database compression is enabled or disabled for platform gateway. You can control this functionality globally by using use_db_compression.

Optional

true

gateway_uwsgi_listen_queue_size

Number of requests uwsgi will allow in the queue on platform gateway until uwsgi_processes can serve them.

Optional

4096

gateway_uwsgi_processes

The number of uwsgi processes for the platform gateway container. The value is calculated based on the number of available vCPUs (virtual CPUs).

Optional

The number of vCPUs multiplied by two, plus one.