5.14 (Kubernetes)
What's new
- MTLS mode has been set to
PERMISSIVE
by default across the entire namespace.
Upgrade Steps
To upgrade the components, follow the instructions below in the order presented.
Prerequisites
If you have made custom changes to your deployment file structure, please contact your Support team before you upgrade your environments.
- Download the latest Cinchy Artifacts from the Cinchy Releases Table > Kubernetes Artifacts column. For this upgrade, please download the Cinchy Kubernetes Deployment Template v5.14.x.zip file.
Depending on your current version, you may need to:
- Run the 5.2 upgrade script
- Run the 5.5 upgrade script
- Make changes to your connection string:
If you are upgrading from 5.0-5.3 to 5.14.x on an SQL Server Database, you will need to make a change to your connectionString
in your SSO and Cinchy appsettings.json. Adding TrustServerCertificate=True will allow you to bypass the certificate chain during validation.
Ex:
"SqlServer" : "Server=MyServer;Database=Cinchy;User ID=cinchy;Password=password;Trusted_Connection=False;Connection Timeout=30;Min Pool Size=10;TrustServerCertificate=True"
Considerations Table
Current Version | Run the 5.2 Upgrade Script | Run the 5.5 Upgrade Script | Connection String Changes (SQL Server DB) |
---|---|---|---|
5.0 | Yes | Yes | Yes |
5.1 | Yes | Yes | Yes |
5.2 | X | Yes | Yes |
5.3 | X | Yes | Yes |
5.4 | X | Yes | X |
5.5 | X | X | X |
5.6 | X | X | X |
5.7 | X | X | X |
5.8 | X | X | X |
5.9 | X | X | X |
5.10 | X | X | X |
5.11 | X | X | X |
5.12 | X | X | X |
5.13 | X | X | X |
Configure to the newest version
Clean existing repositories
- Go to your cinchy.argocd repository. Delete all existing folder structure except for the .git folder/directory and any custom changes you may have implemented.
- Go to your cinchy.kubernetes repository. Delete all existing folder structure except for the
.git
file.
If you have cinchy.kubernetes\cluster_components\servicemesh\istio\istio-injection\argocd-ns.yaml
file and it's not commented, don't change it. Changing this will delete your ArgoCD namespace, which will force you to delete everything from Kubernetes and redeploy.
- Go to your cinchy.terraform repository. Delete all existing folder structure except for the
.git
file. - Go to your cinchy.devops.automation repository. Delete all existing folder structure except for the
.git
file and your deployment.json.
Download k8s template
- Open the
Kubernetes Deployment Template v5.14.1.zip
and place the files into their respective cinchy.kubernetes, cinchy.argocd, cinchy.terraform and cinchy.devops.automation repositories.
Secrets
- If you have AWS Secrets Manager or Azure Key Vault enabled and haven't already done so, create your secrets:
Deployment JSON Update
-
Go to the new
aws.json/azure.json
files and compare them with your currentdeployment.json
file. All additional fields in the newaws.json/azure.json
files should be added to your currentdeployment.json
. -
Update the Kubernetes version in your
deployment.json
. To upgrade EKS to a new version, you need to follow an upgrade sequence, installing each incremental version one by one. For example, you might need to upgrade from 1.27 to 1.28, then from 1.28 to 1.29, and finally from 1.29 to 1.30. -
Open a shell/terminal from the cinchy.devops.automations directory and execute the following command:
dotnet Cinchy.DevOps.Automations.dll "deployment.json"
Terraform Updates
If you are using AWS Secret Manager and have not made this change in any previous upgrade, perform all the steps in this section.
If you are not using AWS Secret Manager or have already made these changes, only perform steps 1 and 5.
- Navigate to your cluster directory:
- For AWS deployments: Navigate to
cinchy.terraform/aws/eks_cluster/<cluster_name>/new-vpc.tf
orcinchy.terraform/aws/eks_cluster/<cluster_name>/existing-vpc.tf
based on your current setup. - For Azure deployments: Navigate to
cinchy.terraform/azure/aks_cluster/<cluster_name>/new-vpc.tf
orcinchy.terraform/azure/aks_cluster/<cluster_name>/existing-vpc.tf
based on your current setup.
- For AWS deployments: Navigate to
- Set the following values temporarily to false:
enable_secrets_store_csi_driver_provider_aws = false
enable_secrets_store_csi_driver = false
- Run the upgrade process:
bash create.sh
- After successful completion, set
enable_secrets_store_csi_driver_provider_aws = true
. This ensures that the appropriate CSI driver is installed, even if AWS Secret Manager is disabled in the deployment JSON. - Run the following:
bash create.sh
Update Cinchy Instance
-
If there were any changes in your cinchy.argocd repository you may need to redeploy ArgoCD. Launch a shell/terminal with the working directory set to the root of the cinchy.argocd repository.
-
Execute the following command to deploy ArgoCD:
bash deploy_argocd.sh
-
Validate ArgoCD pods are running.
-
Execute the following command to deploy/update cluster components and Cinchy components:
bash deploy_cluster_components.sh
bash deploy_cinchy_components.sh
Commit Changes
- Commit changes to Git for all relevant repositories.
- Refresh applications in the ArgoCD console if required.
- All users must log out and back in to your Cinchy environment in order for the changes to properly take effect.
Upgrade AWS EKS and Azure AKS
The following methods can be used upgrade the AWS EKS (from 1.27 up to 1.30.x) and Azure AKS (from 1.27 to 1.29.x) versions.
- For AWS export credentials and for Azure run the
az login
command, if required. - To perform terraform operations, the cluster directory must be the working directory during execution.
- The AWS deployment updates a folder named
eks_cluster
in the Terraform > AWS directory. Within that directory is a subdirectory with the same name as the created cluster. - The Azure deployment updates a folder named
aks_cluster
Within the Terraform > Azure directory. Within that directory is a subdirectory with the same name as the created cluster.
- The AWS deployment updates a folder named
- Go to your cinchy.devops.automations repository and change AKS/EKS version in
deployment.json
(or<cluster name>.json
) within the same directory. - From a shell/terminal, navigate to the cinchy.devops.automations directory location and execute the following command:
dotnet Cinchy.DevOps.Automations.dll "deployment.json"
- Run the command below to start the upgrade process. Make sure to verify before you select yes to upgrade the process. This shouldn't delete or destroy any data. It runs an in-place deployment that will update the Kubernetes version.
bash create.sh
Before accepting the change, verify that it meets your expectations and ensures the protection of your database and any other resources. This command will create, update, or destroy vnet, subnet, AKS cluster, and AKS node groups. Make sure to review the changes before proceeding.