System Requirements for an Existing Cluster Install

here are the system requirements for installing swimlane on an existing kubernetes cluster a kubernetes 1 19 x, 1 20 x, 1 21 x, 1 22 x, 1 23 x, 1 24 x, 1 25 x, or 1 26 x compliant cluster swimlane has tested and verified compatibility with the following managed kubernetes providers amazon eks azure aks google gke k3os v0 20 6 k3s1r0 openshift 4 6 27 versions after this have a dns resolution bug that prevents swimlane from installing properly and can't be used until that is resolved see this red hat bug https //bugzilla redhat com/show bug cgi?id=1967766 for more information a persistent and reliable storageclass to use for the mongodb pods persistent volumes the required filesystem for the mongodb storageclass is xfs cpu architecture must be compatible with mongodb, unless an external mongo solution is used see the mongodb platform support matrix https //www mongodb com/docs/v5 0/administration/production notes/#platform support matrix for more information 3+ node cluster for production environments to provide redundancy and high availability (ha) ensure all nodes are in the same cloud provider region or physical data center network nodes behind different wan links in the same cluster are not supported production environments should have snapshots set up and stored externally from the cluster to ensure that they can be retrieved in the event of a total cluster loss see backup and restore on an existing cluster with snapshots docid\ lm8jy7cus3l3ndyld1n5z for more information on how to set up snapshots and compatible providers a load balancer or ingress controller to load balance to the swimlane platform ui must be configured for tls communication to the backend if your load balancer or ingress controller requires explicit trust with the certificate presented by the backend service then you must upload a trusted certificate for the swimlame web backend the swimlane platform ui must be accessed externally via port 443 accessing swimlane over any other port is not supported must support websockets velero 1 9 0 installed in the cluster to handle backup and restores with snapshots see backup and restore on an existing cluster with snapshots docid\ lm8jy7cus3l3ndyld1n5z for instructions to install velero into your cluster limitations changing annotations, labels, resources, node selector, tolerations, or affinity settings for the swimlane platform installer pods is not currently supported these settings can, however, be set for the swimlane platform pods on the config page the storageclass for the swimlane platform installer pods is required to be default and cannot currently be changed multiple spi installs into the same cluster is not currently supported backup requirements taking a snapshot requires enough free disk space for a compressed archive of the swimlane database to be saved in ephemeral storage before it is uploaded to the snapshot destination free disk space on the cluster at /var/lib/kubelet should be greater than or equal to the size of the uncompressed database to ensure there is no disk pressure during the snapshot process additional offline install requirements in addition to the requirements above, installs into an offline (airgapped) kubernetes cluster have the following additional requirements a private docker image registry accessible by the kubernetes cluster and jumpbox is required for installation and ongoing operation the registry needs to be trusted by your kubernetes cluster in order to be be able to pull images see the kubernetes documentation https //kubernetes io/docs/tasks/configure pod container/pull image private registry/ for more information a jumpbox that has access to the internet, access to the airgapped kubernetes cluster, and a browser from which you can access the swimlane platform installer cluster resources your cluster needs the following resources available to meet the usage thresholds for the given deployment sizes components single node (dev/test) small medium large cpu 8 cpu cores 24 cpu cores 48 cpu cores 96 cpu cores memory 32 gb ram 96 gb ram 192 gb ram 384 gb ram storage 600 gb ssd / 3000 iops per mongodb pod persistent volume 600 gb ssd / 3000 iops per mongodb pod persistent volume 1 tb ssd / 3000 iops per mongodb pod persistent volume 1 tb ssd / 3000 iops per mongodb pod persistent volume record creation boundaries + active users records created in a day 250,000 total records 5 million active users 10 records created in a day 500,000 total records 20 million active users 30 records created in a day 1 million total records 20 million active users 50 records created in a day 1 million total records 20 million active users 200 integration calculations integrations in use < 20 average integration actions/day < 250,000 integrations in use < 20 average integration actions/day < 500,000 integrations in use < 20 average integration actions/day < 1 million integrations in use > 20 average integration actions/day < 1 million pods api 1 tasks 1 web 1 reports 1 mongodb 1 api 3 tasks 3 web 3 reports 3 mongodb 3 api 3 tasks 3 web 3 reports 3 mongodb 3 api 6 tasks 9 web 3 reports 3 mongodb 3 external mongodb resource recommendations the following table illustrates the resource recommendations (per node) for a standalone mongo deployment all of these values can be subtracted from the cluster resources above when allocating resources for the remainder of the swimlane pods for more information about deploying on an external mongodb cluster, see deploy with an external mongodb cluster docid 8ck4wimtlj ehvyruhikw components single node small medium large cpu 4 cpu cores 4 cpu cores 8 cpu cores 8 cpu cores ram 16 gb ram 16 gb ram 16 gb ram 32 gb ram storage 300 gb ssd / 3000 iops per mongodb pod persistent volume 300 gb ssd / 3000 iops per mongodb pod persistent volume 700 gb ssd / 3000 iops per mongodb pod persistent volume 700 gb ssd / 3000 iops per mongodb pod persistent volume remaining swimlane cluster resources this table illustrates the resources necessary for the remainder of swimlane if you are using external mongodb resources components single node small medium large cpu 4 cpu cores 12 cpu cores 24 cpu cores 72 cpu cores ram 16 gb ram 48 gb ram 144 gb ram 288 gb ram storage 300 gb ssd / 3000 iops per node 300 gb ssd / 3000 iops per node 300 gb ssd / 3000 iops per node 300 gb ssd / 3000 iops per node optional pods if you require the use of these optional pods you will need the following additional resources available pod small medium large selenium chromedriver 1 cpu core2 gb ram 1 5 cpu cores3 gb ram 3 cpu core4 gb ram syslog receiver 1 cpu core1 gb ram 4 cpu core1 gb ram 5 cpu core2 gb ram see pod requests and limits docid\ jbsjiyar50ildunxzcftq for a breakdown of resources for each pod type including optional pods not included in the table above external monitoring considerations swimlane recommends that any spi installation has some amount of external monitoring set up and set to alert when any user defined thresholds are met as to possible cases of your production instances going down different installation scenarios may call for different metrics to monitor, so your implementation may vary as a baseline the following metrics are recommended for nodes that are running swimlane pods are all nodes healthy? does each node have sufficient free space in all partitions? are cpu and memory usage levels within acceptable levels? is disk latency within acceptable ranges? are any pods in an not ready state? are any deployments or statefulsets not reporting the correct number of ready replicas? do any load balancers have health checks in place? are they healthy? third party monitoring solutions there are several third party monitoring solutions that you can use to monitor resource usage for a node any tool that you put into use should be installed externally to the cluster so as to not interfere with cluster operations and to be able to alert if a metric enters into a failing scenario these products may require that their own agents or exporters be installed on the nodes in order to facilitate monitoring any agent or exporter should be tested against your cluster to validate that they do not interfere with swimlane operations