Upgrading Cinchy Versions
When it comes time to upgrade your various components, you can do so by updating the version number in your configuration files and applying the changes in ArgoCD.
Warning: If you are upgrading from Cinchy v5.1 or lower to Cinchy v5.2 or higher, please see the Mandatory Upgrade from INT to BigInt and follow the directives on that page.
- 1.Navigate to your cinchy devops.automation repository
- 1.Navigate to your deployment.json (You may have renamed this during your original Kubernetes deployment)
- 2.In the cinchy_instance_configs section, navigate to the image tags. Replace the version number with the instance that you wish to deploy (Ex: v5.1.0 > 5.2.0).
// The component image tags are specified below to define which versions to deploy
"connections_image_tag": "v5.1.0",
"event_listener_image_tag": "v5.1.0",
"idp_image_tag": "v5.1.0",
"maintenance_cli_image_tag": "v5.1.0",
"meta_forms_image_tag": "v5.1.0",
"web_image_tag": "v5.1.0",
"worker_image_tag": "v5.1.0"
2. Rerun the deployment script by using the following command in the root directory of your devops.automations repo:
dotnet Cinchy.DevOps.Automations.dll "deployment.json"
3. Commit and push your changes.
If your environment is not set-up to automatically apply upon configuration, complete the following the apply the newest version:
- 1.Navigate to the ArgoCD portal.
- 2.Refresh your component(s). If that does not work, re-sync.
This process can be run when upgrading from a Cinchy version that is not v5.0+.
- 1.
- 2.
- 1.Swap out the following configs with your current instance configs:
- 1.Cinchy/web.config
- 2.CinchySSO/appsettings.json
- 3.Log4net.config
- 4.Web.config
- 2.Execute the following command:
iisreset -stop
5. Replace the Cinchy and CinchySSO folders with the new build and your merged configs.
6. Execute the following command:
iisreset -start
7. Start Cinchy in your browser.
If you encounter an error during this process, restore your database backup and contact Cinchy Support.
Warning: If you are upgrading from Cinchy v5.1 or lower to Cinchy v5.2 or higher, please see the Mandatory Upgrade from INT to BigInt and follow the directives on that page.This process can be run when upgrading your IIS v4 instance to any v5+ instance
- 1.
- 2.
- 1.Open the C:\CinchySSO\appsettings.json file in a text editor and update the values below.
1. Under AppSettings section, update the values outlined in the table.
2. Wherever you see <base url> in the value, replace this with the actual protocol (i.e. http or https) and the domain name (or ip address) you plan to use.
Ex:. if you're using https with the domain app.cinchy.co, then <base url> should be replaced with https://app.cinchy.co
Key | Value |
|---|---|
CinchyUri | <base url> |
CertificatePath | Adjust the certificate path to point to the CinchySSO v5 folder.
C:\CinchySSO\cinchyidentitysrv.pfx |
StsPublicOriginUri | Base URL used by the .well-known discovery. If left blank will match the request URL. <base url>/cinchysso |
CinchyAccessTokenLifetime | Duration for the Cinchy Access Token. This determines how long a user can be inactive until they need to re-enter their credentials.
It defaults to "0.00:30:00" |
DB Type | Set this to "TSQL" |
4.18.0+ includes session expiration based on the CinchyAccessTokenLifetime. So for the default of "0.00:30:00", this means that if you have been inactive in Cinchy for 30 minutes, your session will expire and you will need to log in again.
Key | Value |
|---|---|
SAMLClientEntityId | Client Entity Id |
SAMLIDPEntityId | Identity Provider Entity Id |
SAMLMetadataXmlPath | Identity Provider metadata XML file path |
SAMLSSOServiceURL | Configure service endpoint for SAML authentication |
AcsURLModule | This parameter is needs to be configured as per your SAML ACS URL. For example, if your ACS URL looks like this - "https:///CinchySSO/identity/AuthServices/Acs", then the value of this parameter should be "/identity/AuthServices" |
In order for the application to connect to the database, the "SqlServer" value needs to be set.
Ensure your database type is set to TSQL.
- 1.Find and update the value under the "ConnectionStrings" section:
"SqlServer" : "User ID=postgres;Password=admin;Host=localhost;Port=5432;Database=cinchynew;Timeout=300;Keepalive=300;"
"SqlServer" : "Server=MyServer;Database=Cinchy;User ID=cinchy;Password=password;Trusted_Connection=False;Connection Timeout=30;Min Pool Size=10;"
"SqlServer" : "Server=MyServer;Database=Cinchy;Trusted_Connection=True;Connection Timeout=30;Min Pool Size=10;"
Under the "ExternalIdentityClaimSection" section you'll see the following values.
These values are used for SAML SSO. If you are not using SSO, keep these values as blank
Key | Value |
|---|---|
ExternalIdentityClaim > FirstName > ExternalClaimName | |
ExternalIdentityClaim > LastName > ExternalClaimName | |
ExternalIdentityClaim > Email > ExternalClaimName | |
ExternalIdentityClaim -> MemberOf -> ExternalClaimName | |
- 1.There is a "Serilog" property that allows you to configure where it logs to. In the below code, update the following:
- 1."Name" must be set to "File" so it writes to a physical file on the disk.
- 2."Path" must be set to the file path to where you want it to log.
"Serilog": {
"MinimumLevel": {
"Default": "Debug",
"Override": {
"Microsoft": "Warning",
"System.Net": "Warning"
}
},
"WriteTo": [
{
"Name": "File",
"Args": {
"path": "C:\\CinchyLogs\\Cinchy\\log.json",
"formatter": "Serilog.Formatting.Compact.CompactJsonFormatter, Serilog.Formatting.Compact"
}
}
]
}
- 1.Navigate to C:\Cinchy
- 2.Delete the appsettings.Development.json
- 3.Navigate to the appsettings.json file and update the following properties:
Key | Value |
|---|---|
StsAuthorityUri | This should match your Cinchy SSO URL |
UseHttps | This is "false" by default. |
DB Type | Set this to "TSQL" |
In order for the application to connect to the database, the "SqlServer" value needs to be set.
Ensure your database type is set to TSQL
- 1.Find and update the value under the "ConnectionStrings" section:
"SqlServer" : ""SqlServer" : "User ID=postgres;Password=admin;Host=localhost;Port=5432;Database=cinchynew;Timeout=300;Keepalive=300;""
"SqlServer" : "Server=MyServer;Database=Cinchy;User ID=cinchy;Password=password;Trusted_Connection=False;Connection Timeout=30;Min Pool Size=10;"
"SqlServer" : "Server=MyServer;Database=Cinchy;Trusted_Connection=True;Connection Timeout=30;
- 1.There is a "Serilog" property that allows you to configure where it logs to. In the below code, update the following:
- "Name" must be set to "File" so it writes to a physical file on the disk.
- "Path" must be set to the file path to where you want it to log.
"Serilog": {
"MinimumLevel": {
"Default": "Debug",
"Override": {
"Microsoft": "Warning",
"System.Net": "Warning"
}
},
"WriteTo": [
{
"Name": "File",
"Args": {
"path": "C:\\CinchyLogs\\Cinchy\\log.json",
"formatter": "Serilog.Formatting.Compact.CompactJsonFormatter, Serilog.Formatting.Compact"
}
}
]
}
You can also use an alternative setting if you want to have rolling log files with retention settings by adding in the following parameters:
"preserveLogFilename": true,
"shared": "true",
"rollingInterval": "Day",
"rollOnFileSizeLimit": true,
"fileSizeLimitBytes": 100000000,
"retainedFileCountLimit": 30,
- Your full "Serilog" property, if you choose to use the alternative settings, would look like this, inputting your own variables as required:
"Serilog": {
"MinimumLevel": {
"Default": "Debug",
"Override": {
"Microsoft": "Warning",
"System.Net": "Warning"
}
},
"WriteTo": [
{
"Name": "File",
"Args": {
"path": "C:\\CinchyLogs\\Cinchy\\log.txt",
"preserveLogFilename": true,
"shared": "true",
"rollingInterval": "Day",
"rollOnFileSizeLimit": true,
"fileSizeLimitBytes": 100000000,
"retainedFileCountLimit": 30,
"formatter": "Serilog.Formatting.Compact.CompactJsonFormatter, Serilog.Formatting.Compact"
}
}
]
}
- 1.Open your Internet Information Services (IIS) Manager.
- 2.Navigate to Connections > Sites.
- 3.Right click on the Cinchy site and select Manage Application > Advanced Settings.
- 4.Change the Cinchy folder path to that of the version you're deploying.
- 5.Right click on the CinchySSO site and select Manage Application > Advanced Settings
- 6.Ensure that both Applications Pools for Cinchy and CinchySSO have their .NET CLR Versions set to No Managed Code.
- 7.Change the Cinchy SSO folder path to that of the version you're deploying.
- 8.Execute the following command:
iisreset -stop
9. Execute the following command:
iisreset -start
10. Open your Cinchy URL in your browser.
Because Cinchy v5 creates new tables and assets in the background upon initialization, this first startup may take longer to fully load than usual.
11. Ensure that you can log in.
If you encounter an error during this process, restore your database backup and contact Cinchy Support.
Warning: If you are upgrading from Cinchy v5.1 or lower to Cinchy v5.2 or higher, please see the Mandatory Upgrade from INT to BigInt and follow the directives on that page.
The following process can be run when upgrading any v5.x instance to any other v5.x instance.
- 1.
- 2.
- 1.Merge the following configs with your current instance configs:
- Cinchy/web.config
- Cinchy/appsettings.json
- CinchySSO/appsettings.json
- CinchySSO/web.config
- 2.Execute the following command:
iisreset -stop
5. Replace the Cinchy and CinchySSO folders with the new build and your merged configs.
6. Execute the following command:
iisreset -start
7. Open your Cinchy URL in your browser.
8. Ensure you can log in.
If you encounter an error during this process, restore your database backup and contact Cinchy Support.