Existing Cluster SPI Config File

below is a reference of the available configurable options for an existing cluster swimlane deployment refer to docid\ tvcynrfn2 8u bhrprbe1 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 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 docid 8ck4wimtlj ehvyruhikw 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