Swimlane Platform Installer Gu...
...
Automate Installation
Embedded Cluster SPI Config File
8 min
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 install docid\ sj2z0crqwphfk7n1o7mut 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 requirement s 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 cluster docid\ aifrfd6ca k0esuklglgo 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"