Cinchy Platform Documentation
Cinchy v5.6
Search
K

Deployment Planning Overview and Checklist

This page is your first stop when considering a deployment of Cinchy v5.

1. Overview

There are various things to consider before deploying Cinchy v5.
The pages in this Deployment Planning section will guide you through the considerations you should think about and the prerequisites that you should implement before deploying version 5 of the Cinchy platform.
The pages in this section include:
  • Deployment Architecture Overview: This page explores your two high-level options for deploying Cinchy, on Kubernetes or on VM, and why we recommend a Kubernetes deployment. It also walks you through the important decision of selecting a database to run your deployment on, as well as some sizing considerations.
    • Kubernetes Deployment Architecture: This page provides Infrastructure (for both Azure and AWS), Cluster, and Platform component overviews for Kubernetes deployments. It also guides you through considerations concerning your cluster configuration.
    • IIS Deployment Architecture: This page provides Infrastructure and Platform component overviews for IIS (VM) deployments.
  • Deployment Prerequisites: This page details important prerequisites for deploying Cinchy v5.

2. Deployment Planning Checklist

We have provided the following checklist for you to use when planning for your Cinchy v5 deployment. Each item is linked to the appropriate documentation page to provide more insight and clarity.

WIndows IIS vs Kubernetes

Kubernetes is an open-source system that manages and automates the full lifecycle of container-based applications. You now have the ability to deploy Cinchy v5 on Kubernetes, and with it comes a myriad of features that help to simplify your deployment and enhance your scaling. Kubernetes can maximize your container capacity and easily scale up/down with your current operations.
You also have the option to run Cinchy on Microsoft IIS, which was the traditional deployment method prior to Cinchy v5. Internet Information Services (IIS) for Windows Server is a flexible, secure and manageable Web server for hosting anything on the Web.
We recommend using Kubernetes to deploy Cinchy v5, because of the robust features that you can leverage, such as improved logging and metrics. Using Kubernetes allows for a greater ability to scale your Cinchy instances as well as the ability to lower your costs by using PostgreSQL.
The main differences between a Kubernetes based deployment and an IIS deployment are:
Kubernetes
Windows IIS
The ability to elastically scale with your business needs.
Limits certain components to running single instances.
Better performance due to Kafka/Redis components.
Kafka/Redis not available as part of the deployment.
Ability to run the Maintenance CLI as a cron job.
Maintenance CLI must be orchestrated using a scheduler.
Detailed logging and metrics capabilities available via Prometheus/Grafana and Opensearch components.
Prometheus/Grafana and Opensearch not available as part of the deployment.
Point to point communication not required to maintain multiple instance caching.
Point to point communications (HTTP requests on the server IPs) is required to maintain caching in the event that multiple instances are stood up.
The use of container images allow for simpler version upgrades.
Does not use container images for upgrades.
Ability to use PostgreSQL database to lower infrastructure costs.
Locked into a TSQL database.
You need to manually manage your cluster(s).
You do not need to manually manage your cluster(s).
If you will be running on Kubernetes, please review the following checklist:
Starting in Cinchy v5.4, you will have the option between Alpine or Debian based image tags for the listener, worker, and connections. Using Debian tags will allow a Kubernetes deployment to be able to connect to a DB2 data source, and that option should be selected if you plan on leveraging a DB2 data sync.
  • When either installing or upgrading your platform, you can use the following Docker image tags for the listener, worker, and connections:
    • "5.x.x" - Alpine
    • "5.x.x-debian" - Debian
If you will be running on IIS, please review the following checklist: