Existing Cluster SPI Config File
Below is a reference of the available configurable options for an existing cluster Swimlane deployment. Refer to Configure the Swimlane Platform for an Existing Cluster InstallConfigure the Swimlane Platform for an Existing Cluster Install for an 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.
All other options are optional, but 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, where applicable:
Configuration Options
Ingress Settings
To access the Swimlane UI, either expose_web_service_externally or swimlane_enable_ingress config options must be enabled.
Key | Description | Requirements | Type | Accepted value (where applicable) |
|---|---|---|---|---|
expose_web_service_externally | Expose the Swimlane web service directly from each node in the cluster on TCP. | ο»Ώ | boolean integer | "0" is false, "1" is true |
expose_web_service_externally_port | Specify the port that the Swimlane web service will use when exposed with expose_web_service_externally. A random port will be selected if this is left unset. | ο»Ώ | integer | ο»Ώ |
swimlane_enable_ingress | Enable ingress options for Swimlane web pods | ο»Ώ | boolean integer | "0" is false, "1" is true |
swimlane_ingress_annotations | Set any ingress annotations for the Swimlane web ingress. | Requires swimlane_enable_ingress to be enabled. | string | ο»Ώ |
swimlane_ingress_hosts | Set a hostname to be used with the Swimlane web ingress. | Requires swimlane_enable_ingress to be enabled. | string | Similar to YAML format: '- ""' |
swimlane_ingress_tls | Set any tls settings for the Swimlane web ingress. | Requires swimlane_enable_ingress to be enabled. | string | Styled as a YAML tls block |
swimlane_set_web_service_annotations | Enable any ingress annotations set with swimlane_web_service_annotations. | ο»Ώ | boolean integer | "0" is false, "1" is true |
swimlane_web_service_annotations | Set any web service annotations required by your ingress. | Requires swimlane_set_web_service_annotations and expose_web_service_externally to be enabled. | string | ο»Ώ |
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 | ο»Ώ |
swimlane_storage_class | Set the name of the storage class that Swimlane will use for MongoDB PVCs | ο»Ώ | string | ο»Ώ |
mongo_volume_size | The size of the PVC that MongoDB will attempt to claim | ο»Ώ | integer | ο»Ώ |
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 |
Affinity Settings
Key | Description | Requirements | Type | Accepted value (where applicable) |
|---|---|---|---|---|
simple_affinity | Set anti-affinity for API, Chrome, Reports, Syslog, Tasks, Tools, and Web pods to "soft" and MongoDB pods to "hard". | ο»Ώ | boolean integer | "0" is false, "1" is true |
mongo_anti_affinity | Anti-affinity setting for the MongoDB replicaset. | Requires simple_affinity to be enabled. | string | "hard", "soft", or "none" |
pod_anti_affinity | Anti-affinity setting for the MongoDB replicaset. | Requires simple_affinity to be enabled. | string | "hard", "soft", or "none" |
pod_affinity_api | Set anti-affinity setting for the Swimlane API pods. | Requires simple_affinity to be disabled. | string | "hard", "soft", or "none" |
pod_affinity_chrome | Set anti-affinity setting for the Swimlane Chrome pods. | Requires simple_affinity to be disabled. | string | "hard", "soft", or "none" |
pod_affinity_mongodb | Set anti-affinity setting for the MongoDB pods. | Requires simple_affinity to be disabled. | string | "hard", "soft", or "none" |
pod_affinity_reports | Set anti-affinity setting for the Swimlane Reports pods. | Requires simple_affinity to be disabled. | string | "hard", "soft", or "none" |
pod_affinity_syslog | Set anti-affinity setting for the Swimlane Syslog pods. | Requires simple_affinity to be disabled. | string | "hard", "soft", or "none" |
pod_affinity_tasks | Set anti-affinity setting for the Swimlane Tasks pods. | Requires simple_affinity to be disabled. | string | "hard", "soft", or "none" |
pod_affinity_tools | Set anti-affinity setting for the Swimlane Tools pods. | Requires simple_affinity to be disabled. | string | "hard", "soft", or "none" |
pod_affinity_web | Set anti-affinity setting for the Swimlane Web pods. | Requires simple_affinity to be disabled. | string | "hard", "soft", or "none" |
Service Account Settings
Key | Description | Requirements | Type | Accepted value (where applicable) |
|---|---|---|---|---|
create_tools_service_account | Ensure the creation of a service account for Swimlane Tools. | ο»Ώ | string | "create_tools_service_account_true" or "create_tools_service_account_false" |
set_service_accounts | Enable any pod service account names that were set with the service_account_name__<pod_name> config option. | ο»Ώ | boolean integer | "0" is false, "1" is true |
service_account_name_api | Set the name of the service account that the Swimlane API pods will use. | Requires set_service_accounts to be enabled. | string | ο»Ώ |
service_account_name_chrome | Set the name of the service account that the Swimlane Chrome pods will use. | Requires set_service_accounts to be enabled. | string | ο»Ώ |
service_account_name_mongodb | Set the name of the service account that the MongoDB pods will use. | Requires set_service_accounts to be enabled. | string | ο»Ώ |
service_account_name_reports | Set the name of the service account that the Swimlane Reports pods will use. | Requires set_service_accounts to be enabled. | string | ο»Ώ |
service_account_name_syslog | Set the name of the service account that the Swimlane Syslog pods will use. | Requires set_service_accounts to be enabled. | string | ο»Ώ |
service_account_name_tasks | Set the name of the service account that the Swimlane Tasks pods will use. | Requires set_service_accounts to be enabled. | string | ο»Ώ |
service_account_name_tools | Set the name of the service account that the Swimlane Tools pods will use. | Requires set_service_accounts to be enabled. | string | ο»Ώ |
service_account_name_web | Set the name of the service account that the Swimlane Web pods will use. | Requires set_service_accounts to be enabled. | string | ο»Ώ |
Annotation Settings
Key | Description | Requirements | Type | Accepted value (where applicable) |
|---|---|---|---|---|
set_pod_annotations | Enable any pod annotations that were set with the pod_annotations_<pod_name> config option. | ο»Ώ | boolean integer | "0" is false, "1" is true |
pod_annotations_api | Set additional pod annotations for the Swimlane API pods. | Requires set_pod_annotations to be enabled. | string | ο»Ώ |
pod_annotations_chrome | Set additional pod annotations for the Swimlane Chrome pods. | Requires set_pod_annotations to be enabled. | string | ο»Ώ |
pod_annotations_mongodb | Set additional pod annotations for the MongoDB pods. | Requires set_pod_annotations to be enabled. | string | ο»Ώ |
pod_annotations_reports | Set additional pod annotations for the Swimlane Reports pods. | Requires set_pod_annotations to be enabled. | string | ο»Ώ |
pod_annotations_syslog | Set additional pod annotations for the Swimlane Syslog pods. | Requires set_pod_annotations to be enabled. | string | ο»Ώ |
pod_annotations_tasks | Set additional pod annotations for the Swimlane Tasks pods. | Requires set_pod_annotations to be enabled. | string | ο»Ώ |
pod_annotations_tools | Set additional pod annotations for the Swimlane Tools pods. | Requires set_pod_annotations to be enabled. | string | ο»Ώ |
pod_annotations_web | Set additional pod annotations for the Swimlane Web pods. | Requires set_pod_annotations to be enabled. | string | ο»Ώ |
Label Settings
Key | Description | Requirements | Type | Accepted value (where applicable) |
|---|---|---|---|---|
set_pod_labels | Enable any pod labels that were set with the pod_labels_<pod_name> config option. | ο»Ώ | boolean integer | "0" is false, "1" is true |
pod_labels_api | Set additional pod labels for the Swimlane API pods. | Requires set_pod_labels to be enabled. | string | ο»Ώ |
pod_labels_chrome | Set additional pod labels for the Swimlane Chrome pods. | Requires set_pod_labels to be enabled. | string | ο»Ώ |
pod_labels_mongodb | Set additional pod labels for the MongoDB pods. | Requires set_pod_labels to be enabled. | string | ο»Ώ |
pod_labels_reports | Set additional pod labels for the Swimlane Reports pods. | Requires set_pod_labels to be enabled. | string | ο»Ώ |
pod_labels_syslog | Set additional pod labels for the Swimlane Syslog pods. | Requires set_pod_labels to be enabled. | string | ο»Ώ |
pod_labels_tasks | Set additional pod labels for the Swimlane Tasks pods. | Requires set_pod_labels to be enabled. | string | ο»Ώ |
pod_labels_tools | Set additional pod labels for the Swimlane Tools pods. | Requires set_pod_labels to be enabled. | string | ο»Ώ |
pod_labels_web | Set additional pod labels for the Swimlane Web pods. | Requires set_pod_labels to be enabled. | string | ο»Ώ |
Resource Settings
Key | Description | Requirements | Type | Accepted value (where applicable) |
|---|---|---|---|---|
set_pod_resources | Enable any pod resource limits that were set with the pod_resources_<pod_name> config option. | ο»Ώ | boolean integer | "0" is false, "1" is true |
pod_resources_api | Set pod resource limits for the Swimlane API pods. | Requires set_pod_resources to be enabled. | string | ο»Ώ |
pod_resources_chrome | Set pod resource limits for the Swimlane Chrome pods. | Requires set_pod_resources to be enabled. | string | ο»Ώ |
pod_resources_mongodb | Set pod resource limits for the Main MongoDB pods. | Requires set_pod_resources to be enabled. | string | ο»Ώ |
pod_resources_mongodb_init | Set pod resource limits for the Initial MongoDB pods. | Requires set_pod_resources to be enabled. | string | ο»Ώ |
pod_resources_reports | Set pod resource limits for the Swimlane Reports pods. | Requires set_pod_resources to be enabled. | string | ο»Ώ |
pod_resources_syslog | Set pod resource limits for the Swimlane Syslog pods. | Requires set_pod_resources to be enabled. | string | ο»Ώ |
pod_resources_tasks | Set pod resource limits for the Swimlane Tasks pods. | Requires set_pod_resources to be enabled. | string | ο»Ώ |
pod_resources_tools | Set pod resource limits for the Swimlane Tools pods. | Requires set_pod_resources to be enabled. | string | ο»Ώ |
pod_resources_web | Set pod resource limits for the Swimlane Web pods. | Requires set_pod_resources to be enabled. | string | ο»Ώ |
Node Selector Settings
Key | Description | Requirements | Type | Accepted value (where applicable) |
|---|---|---|---|---|
set_pod_node_selectors | Enable any node selecters that were set with the node_selectors_<pod_name> config option. | ο»Ώ | boolean integer | "0" is false, "1" is true |
node_selectors_api | Set additional node selectors for the Swimlane API pods. | Requires set_pod_node_selectors to be enabled. | string | ο»Ώ |
node_selectors_chrome | Set additional node selectors for the Swimlane Chrome pods. | Requires set_pod_node_selectors to be enabled. | string | ο»Ώ |
node_selectors_mongodb | Set additional node selectors for the MongoDB pods. | Requires set_pod_node_selectors to be enabled. | string | ο»Ώ |
node_selectors_reports | Set additional node selectors for the Swimlane Reports pods. | Requires set_pod_node_selectors to be enabled. | string | ο»Ώ |
node_selectors_syslog | Set additional node selectors for the Swimlane Syslog pods. | Requires set_pod_node_selectors to be enabled. | string | ο»Ώ |
node_selectors_tasks | Set additional node selectors for the Swimlane Tasks pods. | Requires set_pod_node_selectors to be enabled. | string | ο»Ώ |
node_selectors_tools | Set additional node selectors for the Swimlane Tools pods. | Requires set_pod_node_selectors to be enabled. | string | ο»Ώ |
node_selectors_web | Set additional node selectors for the Swimlane Web pods. | Requires set_pod_node_selectors to be enabled. | string | ο»Ώ |
Tolerations Settings
Key | Description | Requirements | Type | Accepted value (where applicable) |
|---|---|---|---|---|
set_pod_tolerations | Enable any pod tolerations that were set with the pod_tolerations_<pod_name> config option. | ο»Ώ | boolean integer | "0" is false, "1" is true |
pod_tolerations_api | Set pod tolerations for the Swimlane API pods. | Requires set_pod_tolerations to be enabled. | string | ο»Ώ |
pod_tolerations_chrome | Set pod tolerations for the Swimlane Chrome pods. | Requires set_pod_tolerations to be enabled. | string | ο»Ώ |
pod_tolerations_mongodb | Set pod tolerations for the MongoDB pods. | Requires set_pod_tolerations to be enabled. | string | ο»Ώ |
pod_tolerations_reports | Set pod tolerations for the Swimlane Reports pods. | Requires set_pod_tolerations to be enabled. | string | ο»Ώ |
pod_tolerations_syslog | Set pod tolerations for the Swimlane Syslog pods. | Requires set_pod_tolerations to be enabled. | string | ο»Ώ |
pod_tolerations_tasks | Set pod tolerations for the Swimlane Tasks pods. | Requires set_pod_tolerations to be enabled. | string | ο»Ώ |
pod_tolerations_tools | Set pod tolerations for the Swimlane Tools pods. | Requires set_pod_tolerations to be enabled. | string | ο»Ώ |
pod_tolerations_web | Set pod tolerations for the Swimlane Web pods. | Requires set_pod_tolerations to be enabled. | string | ο»Ώ |