Embedded Cluster SPI Config File
Here is a reference of the available configurable options for an embedded cluster Swimlane deployment. Refer to Configure the Swimlane Platform for an Embedded Cluster InstallConfigure the Swimlane Platform for an Embedded Cluster Install for more explanation of these options.
Required Configuration Options
An SPI config file requires certain MongoDB options to be set in order to be valid for deployment. These options will change depending on your MongoDB setup. Refer to the MongoDB Settings section to determine which settings you need to create a valid SPI config file.
Some options are dependent on other options being enabled or set to valid values, refer to the Requirements column in each of the sections below:
Configuration Options
Ingress Settings
To access the Swimlane UI, either expose_web_service_externally or use_included_ingress config options must be enabled.
Key | Description | Requirements | Type | Accepted value (where applicable) |
|---|---|---|---|---|
expose_web_service_externally | Enable this option when using a Layer 7 load balancer. The Swimlane web service will be directly exposed from each node in the cluster on TCP port 4443. | ο»Ώ | boolean integer | "0" is false, "1" is true |
swimlane_hostname | Set the hostname used to access swimlane. | Requires use_included_ingress to be enabled. | string | FQDN Hostname |
use_included_ingress | Enable the included ingress to access the Swimlane web pod. | Requires swimlane_hostname to be set. | boolean integer | "0" is false, "1" is true |
swimlane_tls_cert_upload | Enable the upload of a certificate and key for Swimlane web traffic. | Requires use_included_ingress to be enabled. | boolean integer | "0" is false, "1" is true |
swimlane_tls_cert | Set the certificate that you want Swimlane to use for web traffic. Corresponds to swimlane_tls_key config option. | Requires use_included_ingress and swimlane_tls_cert_upload to be enabled. | Base64 Encoded RSA Formatted Certificate | ο»Ώ |
swimlane_tls_key | Set the key that you want Swimlane to use for web traffic. Corresponds to swimlane_tls_cert config option. | Requires use_included_ingress and swimlane_tls_cert_upload to be enabled. | Base64 Encoded RSA Formatted Key | ο»Ώ |
swimlane_tls_cert_upload_backend | Enable the upload of a cerfificate and key for Swimlane backend traffic. | ο»Ώ | boolean integer | "0" is false, "1" is true |
swimlane_tls_cert_backend | Set the certificate that you want Swimlane to use for backend traffic. Corresponds to swimlane_tls_key_backed config option. | Requires swimlane_tls_cert_upload_backend to be enabled. | Base64 Encoded RSA Formatted Certificate | ο»Ώ |
swimlane_tls_key_backend | Set the key that you want Swimlane to use for backend traffic. Corresponds to swimlane_tls_cert_backend config option. | Requires swimlane_tls_cert_upload_backend to be enabled. | Base64 Encoded RSA Formatted Key | ο»Ώ |
Swimlane Settings
Key | Description | Requirements | Type | Accepted value (where applicable) |
|---|---|---|---|---|
aspnetcore_environment_type | The type of Swimlane environment - either Development or Production. | ο»Ώ | string | "aspnetcore_environment_development" or "aspnetcore_environment_production" |
swimlane_audit_logging | Turn Audit Logging on or off for Swimlane. | ο»Ώ | boolean integer | "0" is false, "1" is true |
swimlane_audit_logging_level | The logging level for the Swimlane audit logs. | Requires swimlane_audit_logging to be enabled. | string | "Debug", "Info", "Warn", or "Error" |
swimlane_openssl_cipherstring | Set the level of openssl cipher. | ο»Ώ | string | DEFAULT@SECLEVEL=2 |
swimlane_openssl_minprotocol | Set the minimum level of OpenSSL protocol. | ο»Ώ | string | TLSv1.2 |
mongo_external_service | Expose MongoDB externally on each node | Only applicable with embedded MongoDB | boolean integer | "0" is false, "1" is true |
pip_config | The pip config file that will be uploaded into the Swimlane pods. | Requires pip_config_upload to be enabled. | Base64 Encoded pip config file | ο»Ώ |
pip_config_upload | Enable the upload of the pip config file specified in pip_config. | ο»Ώ | boolean integer | "0" is false, "1" is true |
swimlane_chrome | Enable the Swimlane chrome pod for deployment. | ο»Ώ | boolean integer | "0" is false, "1" is true |
swimlane_syslog_receiver | Enable the Swimlane syslog receiver pod for deployment. | ο»Ώ | boolean integer | "0" is false, "1" is true |
swimlane_syslog_receiver_port | Set the port the Swimlane syslog receiver will use. | Requires swimlane_syslog_receiver to be enabled | integer | ο»Ώ |
third_party_certs | Set any third party certs that you want Swimlane to be able to use. | Requires third_party_certs_upload to be enabled. | Base64 Encoded RSA Formatted CA Certificate> | ο»Ώ |
third_party_certs_upload | Enable the upload of any third party certs. | ο»Ώ | boolean integer | "0" is false, "1" is true |
MongoDB Settings
MongoDB can either be deployed as part of the embedded cluster or connected to externally. The config option mongo_use_external_deployment controls this setting. By default, this is set to 0, meaning an embedded cluster will be deployed and used. If set to 1, no embedded MongoDB cluster will be deployed. Refer to Deploy with an External MongoDB ClusterDeploy with an External MongoDB Cluster for more explanation on external cluster options.
Required Embedded MongoDB Settings
These settings are required to be set for any SPI Install with an embedded MongoDB cluster.
Key | Description | Requirements | Type | Accepted value (where applicable) |
|---|---|---|---|---|
swimlane_database_encrypt_key | Set the database encryption key for MongoDB | Has to be identical to swimlane_database_encrypt_key_confirm | Base64 Encoded String | ο»Ώ |
swimlane_database_encrypt_key_confirm | Confirm the database encryption key for MongoDB | Has to be identical to swimlane_database_encrypt_key | Base64 Encoded String | ο»Ώ |
mongo_admin_user_password | The MongoDB password for the Admin user. | Requires mongo_admin_user_password_confirm to be set and identical. | Base64 Encoded String | ο»Ώ |
mongo_admin_user_password_confirm | Confirmation for the MongoDB password for the Admin user. | Requires mongo_admin_user_password to be set and identical. | Base64 Encoded String | ο»Ώ |
mongo_swimlane_user_password | Set the MongoDB password for the Swimlane user. | Requires mongo_swimlane_user_password_confirm to be set and identical. | Base64 Encoded String | ο»Ώ |
mongo_swimlane_user_password_confirm | Confirm the MongoDB password for the Swimlane user. | Requires mongo_swimlane_user_password to be set and identical. | Base64 Encoded String | ο»Ώ |
Required External MongoDB Settings
These settings are required to be set for any SPI Install that connects to an external MongoDB cluster.
Key | Description | Requirements | Type | Accepted value (where applicable) |
|---|---|---|---|---|
swimlane_database_encrypt_key | Set the database encryption key for MongoDB | Has to be identical to swimlane_database_encrypt_key_confirm | Base64 Encoded String | ο»Ώ |
swimlane_database_encrypt_key_confirm | Confirm the database encryption key for MongoDB | Has to be identical to swimlane_database_encrypt_key | Base64 Encoded String | ο»Ώ |
mongo_use_external_deployment | Enable the usage of an external MongoDB database | Requires mongo_use_external_deployment to be enabled. | boolean integer | "0" is false, "1" is true |
mongo_external_db | Set the name of the Swimlane database in your external MongoDB | Requires mongo_use_external_deployment to be enabled. | string | ο»Ώ |
mongo_external_history_db | Set the name of the Swimlane History database in your external MongoDB | Requires mongo_use_external_deployment to be enabled. | string | ο»Ώ |
mongo_external_history_host | Set the host name that will be used in the MongoDB connection URI string for the Swimlane History database. | Requires mongo_use_external_deployment to be enabled. | string | ο»Ώ |
mongo_external_history_options | Set any options that will be used in the MongoDB connection URI string for the Swimlane History database. | Requires mongo_use_external_deployment to be enabled. | string | ο»Ώ |
mongo_external_history_user | Set the name of the user that will be used in the MongoDB connection URI string for the Swimlane History database. | Requires mongo_use_external_deployment to be enabled. | string | ο»Ώ |
mongo_external_host | Set the host name that will be used in the MongoDB connection URI string for the Swimlane database. | Requires mongo_use_external_deployment to be enabled. | string | ο»Ώ |
mongo_external_options | Set any options that will be used in the MongoDB connection URI string for the Swimlane database. | Requires mongo_use_external_deployment to be enabled. | string | ο»Ώ |
mongo_external_user | Set the name of the user that will be used in the MongoDB connection URI string for the Swimlane database. | Requires mongo_use_external_deployment to be enabled. | string | ο»Ώ |
mongo_external_user_history_password | Set the password that will be used in the MongoDB connection URI string for the Swimlane History database. | Requires mongo_use_external_deployment to be enabled and mongo_external_user_history_password_confirm to be set and identical. | string | ο»Ώ |
mongo_external_user_history_password_confirm | Confirm the password that will be used in the MongoDB connection URI string for the Swimlane History database. | Requires mongo_use_external_deployment to be enabled and mongo_external_user_history_password to be set and identical. | ο»Ώ | ο»Ώ |
mongo_external_user_password | Set the password that will be used in the MongoDB connection URI string for the Swimlane database. | Requires mongo_use_external_deployment to be enabled and mongo_external_user_password_confirm to be set and identical. | ο»Ώ | ο»Ώ |
mongo_external_user_password_confirm | Confirm the password that will be used in the MongoDB connection URI string for the Swimlane database. | Requires mongo_use_external_deployment to be enabled and mongo_external_user_password to be set and identical. | ο»Ώ | ο»Ώ |
Optional External MongoDB Settings
These settings are optional for an SPI Install that connects to an external MongoDB cluster:
Key | Description | Requirements | Type | Accepted value (where applicable) |
|---|---|---|---|---|
mongo_ca_cert | Set the ca certificate if you need one to connect to the Swimlane database in your external MongoDB. | Requires mongo_use_external_deployment to be enabled and mongo_external_upload_certs to be enabled. | Base64 Encoded RSA Formatted Certificate | ο»Ώ |
mongo_external_upload_certs | Enable uploading of the ca cert specified with mongo_ca_cert. | Requires mongo_use_external_deployment to be enabled | boolean integer | "0" is false, "1" is true |
mongo_external_history_options | Set any options that will be used in the MongoDB connection URI string for the Swimlane History database. | Requires mongo_use_external_deployment to be enabled | string | ο»Ώ |
mongo_external_history_prefix | Set the prefix that will be used in the MongoDB connection URI string for the Swimlane History database. | Requires mongo_use_external_deployment to be enabled | string | ο»Ώ |
mongo_external_options | Set any options that will be used in the MongoDB connection URI string for the Swimlane database. | Requires mongo_use_external_deployment to be enabled | string | ο»Ώ |
mongo_external_prefix | Set the prefix that will be used in the MongoDB connection URI string for the Swimlane database. | Requires mongo_use_external_deployment to be enabled | string | ο»Ώ |
mongo_history_ca_cert | Set the ca certificate if you need one to connect to the Swimlane History database in your external MongoDB. | Requires mongo_use_external_deployment to be enabled and mongo_external_history_upload_certs to be enabled. | Base64 Encoded RSA Formatted Certificate | ο»Ώ |
mongo_external_history_upload_certs | Enable uploading of the ca cert specified with mongo_history_ca_cert. | Requires mongo_use_external_deployment to be enabled | boolean integer | "0" is false, "1" is true |
High Availability Settings
Key | Description | Requirements | Type | Accepted value (where applicable) |
|---|---|---|---|---|
is_ha | Enable this option to deploy Swimlane with high availability after joining multiple nodes. | ο»Ώ | boolean integer | "0" is false, "1" is true |
api_replicas | Set the number of Swimlane API pods. | Requires is_ha to be enabled. | integer | "1" if a single node deployment or "3"+ if Swimlane is deployed HA |
mongo_replicas | Set the number of MongoDB replica pods. | Requires is_ha to be enabled. | integer | "1" if a single node deployment or "3"+ if Swimlane is deployed HA |
report_replicas | The number of Swimlane Reports pods. | Requires is_ha to be enabled. | integer | "1" if a single node deployment or "3"+ if Swimlane is deployed HA |
task_replicas | The number of Swimlane task pods. | Requires is_ha to be enabled. | integer | "1" if a single node deployment or "3"+ if Swimlane is deployed HA |
web_replicas | The number of Swimlane web pods. | Requires is_ha to be enabled. | integer | "1" if a single node deployment or "3"+ if Swimlane is deployed HA |
mongo_anti_affinity | Anti-affinity setting for the MongoDB replicaset. | Requires is_ha to be enabled. | string | "hard", "soft", or "none" |
pod_anti_affinity | Anti-affinity setting for the MongoDB replicaset. | Requires is_ha to be enabled. | string | "hard", "soft", or "none" |