Swimlane Platform Installer Gu...
Existing Cluster Installation
Configure the Swimlane Platform for an Existing Cluster Install
1 min
when you need to access the spi ui after the initial install you can proxy it again by running this command and accessing http //localhost 8800 in a chrome browser kubectl kots admin console namespace your namespace all configuration of the swimlane platform installer and swimlane platform must be done through the spi admin console config page editing or manipulating the underlying kubernetes resources is not supported and will not be permanent since they are managed and controlled by the swimlane platform installer first, configure ingress options enable ingress resource enable this option if you have an existing ingress controller installed in your cluster that you want to utilize to expose swimlane externally ingress resource annotations enter the annotations to apply to the ingress resource see the documentation for your ingress controller for the required annotations to work properly if your ingress controller requires a nodeport service then you must enabled the expose the swimlane web service externally option below ingress resource tls enter the tls section for the ingress resource see your ingress controller’s documentation for the required tls settings see the kubernetes documentation for valid ingress tls yaml https //kubernetes io/docs/concepts/services networking/ingress/#tls ingress resource hostnames enter the hostnames to match to this ingress resource enter one per line with each line starting with a dash and a space (e g " hostname example") you must use dns compliant records a dns record can be up to 63 characters long and can only contain letters, numbers, and hyphens the record cannot start or end with a hyphen, or have consecutive hyphens if left blank, it will match all hostnames expose the swimlane web service externally enable this option to expose the swimlane web service as a nodeport from each node in the cluster on the tcp port below you must configure your external layer 7 load balancer to forward to each node over the chosen port swimlane web service port enter the port to use for the externally exposed swimlane web service this port must be within your cluster's nodeport range if left blank, it will use a random port in your cluster's nodeport range set swimlane web service annotations enter the annotations to apply to the swimlane web service see the documentation for your ingress controller for the required annotations to work properly upload a certificate for swimlane web backend enable this option to upload a certificate and key to be used by the backend swimlane web service if no certificate is uploaded a self signed one will be used swimlane web cors headers enable this option to set http cross origin resource sharing headers for swimlane web a list of options relevant to cors headers will appear below and if left blank, they will be set with the default values specified next to each option if this option is disabled, no cors headers will be set for swimlane web swimlane web cors header access control allow origin determine whether to override the value for the http access control allow origin header https //developer mozilla org/en us/docs/web/http/headers/access control allow origin swimlane web cors header access control allow headers determine whether to override the value for the http access control allow headers header https //developer mozilla org/en us/docs/web/http/headers/access control allow headers swimlane web cors header access control allow methods determine whether to override the value for the http access control allow methods header https //developer mozilla org/en us/docs/web/http/headers/access control allow methods swimlane web csp header enable this option to set the http content security policy header for swimlane web a new option will appear below to override the csp header, if left blank it will get set to the default value if this option is disabled, no csp header will be set for swimlane web swimlane web content security policy header determine whether to override the value for the http content security policy header https //developer mozilla org/en us/docs/web/http/headers/content security policy swimlane recommends that you have your ingress controller or load balancer set to have no request timeout, no idle timeout, and no request body size limit so that these are limited only by the swimlane web pods next, set the logging settings asp net hosting environment set this option to development to have stack traces sent to the browser for 500 errors set this option to production to not send them enable swimlane audit logging enable this option to log raw swimlane api requests and responses into swimlane pods swimlane logging level set this option to specify the logging level for swimlane pods next, determine whether to override the openssl settings for cipherstring and minprotocol for outgoing secure connections that originate from api and tasks pods important! since outgoing secure connections include requests to the swimlane api service, there are limitations to what can be set for these values in order to not break your deployment of swimlane minprotocol should not be set to anything higher than tlsv1 2, and cipherstring can be set to the highest security level like high\@seclevel=5 or default\@seclevel=5 next, determine whether to enable the swimlane syslog receiver and the selenium chromedriver enable the swimlane syslog receiver determine whether you want mongodb to be exposed for external access, and whether to pload pip config for api and tasks if you have third party certificates for api and tasks, click upload additional trusted certificates for api and tasks and then browse for and upload your certificates next, choose whether to enable or disable a pod liveness probe for the api and tasks pods the default liveness probe setting for api pods is disabled and for tasks pods is enabled on initial mongodb settings, enter the appropriate encryption keys and passwords for your swimlane database and mongodb you can skip steps 7 and 8 if you are using an external mongodb cluster for more information, see deploy with an external mongodb cluster docid 8ck4wimtlj ehvyruhikw important! do not change the mongodb settings after installation doing so will break your deployment of swimlane here are the acceptable special characters to use in keys and passwords !@#$%^& () =+/\[]| ;<,> ?` next, set the mongodb volume size and storageclass mongodb volume size (gb) the size in gb for the mongodb persistent volume storageclass for mongodb data the storageclass to use for the mongodb persistent volume next, set the ha environment settings for this cluster enable this to set the number of pods of each type to run these settings should only be enabled if your cluster has 3 or more nodes if you are installing on a single node deployment this option should not be enabled important! the number of mongodb replicas value must be at least 3 and be an odd number to ensure the replica set primary failover can happen properly when needed next, set the affinity settings use simple pod affinity use simplified affinity options to decide how to balance the swimlane and mongodb pods across your cluster nodes important! changing affinity settings can change the nodes that pods are running on if the storageclass chosen for the mongodb pods does not support pvcs being accessed by multiple cluster nodes then changing the mongodb affinity settings may result in the config change failing to deploy next, set the service account settings automatically create and set the service account used by the swimlane tools deployment when enabled, a service account, role, and role binding named swimlane backup will be created in the namespace swimlane is installed in that will be used by the swimlane tools deployment this service account requires special permissions in order for the swimlane tools deployment to process snapshots and support bundles uncheck this if you want to create the service account manually and then enable the set the service account option and define the name of it below kubernetes service account name for the swimlane tools deployment the service account name to use for the swimlane tools deployment set service accounts enable this if you need to set the kubernetes serviceaccountname for each pod type pod types that don't require special settings can be left blank see service account permissions docid\ cdzbmmda3n7r9evmvfse3 for more information on the required permissions for the pod types that require it important! the swimlane tools deployment requires a service account you must either enable the automatically create and set the service account used by the swimlane tools deployment option or create the service account and set it for the swimlane tools deployment under the kubernetes service account name for the swimlane tools deployment option next, set the pod annotations settings set pod annotations enable this if you need to to set pod annotations for the swimlane deployments pod types that don't require special settings can be left blank see the kubernetes annotations https //kubernetes io/docs/concepts/overview/working with objects/annotations/#syntax and character set documentation for valid annotations yaml sample annotations annotation1 "value1" annotation2 "value2" next, set the pod labels settings set pod labels enable this if you need to set pod labels for the swimlane deployments pod types that don't require special settings can be left blank see the kubernetes labels https //kubernetes io/docs/concepts/overview/working with objects/labels/#syntax and character set documentation for valid label yaml next, set the pod resources settings set pod resources enable this if you need to set pod resources for the swimlane deployments pod types that don't require special settings can be left blank see the kubernetes resources https //kubernetes io/docs/concepts/configuration/manage resources containers/ documentation for valid resources yaml see pod requests and limits docid\ jbsjiyar50ildunxzcftq for a breakdown of requests and limits for each pod type sample pod resources requests memory "500m" cpu "500m" limits memory "1g" cpu "1000m" next, set the pod node selectors settings set pod node selectors enable this if you need to set pod node selectors for the swimlane deployments pod types that don't require special settings can be left blank see the kubernetes node selectors https //kubernetes io/docs/concepts/scheduling eviction/assign pod node/#nodeselector documentation for valid node selectors yaml sample node selector nodelabel value next, set the pod tolerations settings set pod tolerations enable this if you need to set pod tolerations for the swimlane deployments pod types that don't require special settings can be left blank see the kubernetes tolerations https //kubernetes io/docs/concepts/scheduling eviction/taint and toleration/ documentation for valid tolerations yaml sample toleration when you save the configuration, preflight checks for your installation begin if any preflight checks are not passing, you must address them before continuing if all preflight checks pass, the swimlane platform will deploy click continue to access the swimlane platform installer admin console once the status of your application says ready you have a successful installation of swimlane next, see backup and restore on an existing cluster with snapshots docid\ lm8jy7cus3l3ndyld1n5z to set up snapshots