LTS21 Migration Guide

Introduction

This guide describes how to upgrade a Nevis setup from LTS-2019 to LTS-2021.

The upgrade needs to be done as part of a migration project.

Nevis integration partners can help customers to manage and execute these projects to successfully deliver a production ready, migrated, latest version of the Nevis Identity Suite.

Prerequisite

To upgrade from LTS-2019 to LTS-2021, you need to have the most recent LTS-2019 patch version installed.

Upgrading your components will require database changes. As the LTS-2021 database schemas are not compatible with LTS-2019, you also need to shut down the affected Nevis components.

Migration Guidelines

The following guidelines describe an in-place upgrade.

Alternatively, you may set up a new environment and perform the upgrade there. This reduces risks and downtime. When the new environment is ready, you need to route the traffic to that new environment.

Manual Setup (for non-nevisAdmin users)

If the components are installed manually, we cannot offer an automatic upgrade. Upgrade to LTS-21 as follows:

1. Analyse your configuration and apply the required changes for each Nevis component.
2. The required changes are summarized in the LTS Migration Guide of the components (see References below).
3. Even if you did not change anything, we recommend to check the LTS Migration Guide of the components for new component behavior due to changes in default values.
4. Upgrade your target systems according to the requirements defined in [Nevis Product Lifetime and Platform Support Matrix 2.202111 Home].
5. For some Nevis components, a database schema upgrade is required. Check the components technical documentation for upgrade instructions.
6. Stop the affected components while the database schema is upgraded.
7. Restart or reboot the upgraded systems.
8. As LTS-21 contains significant improvements, test all use cases extensively with your partners.

nevisAdmin 3 Users

1. Ensure nevisAdmin 3 is upgraded to the latest 3.8.x version.

2. Note that upgrading the nevisAppliance which runs nevisAdmin automatically upgrades nevisAdmin 3 as well.

3. Analyse the configuration in nevisAdmin 3, and apply the required changes for each Nevis component.

4. Check your nevisAdmin 3 Environment and Infrastructure tabs.

5. As nevisAdmin 3 provides some high-level features, fewer changes are expected than in a manual setup.

6. The required changes are summarized in the LTS Migration Guide of the components (see References).

7. Even if did not change anything, check the LTS Migration Guide of the components for new component behavior due to changes in default values.

8. Commit your nevisAdmin 3 environments.

9. Upgrade your target systems according to the requirements defined in [Nevis Product Lifetime and Platform Support Matrix].

10. For some Nevis components, a database schema upgrade is required. Check the technical documentation of each components for upgrade instructions.

11. Stop the affected components while performing the database schema upgrade.

12. Deploy your nevisAdmin 3 environments.

13. As LTS-21 contains significant improvements, extensively test all use cases with your partners.

nevisAdmin 4 Users

1. Upgrade nevisAdmin 4 according to the [Software Upgrade] guide.

2. nevisAdmin 4 comes with the latest Standard libraries, first, update your project to use them.

3. Go to Administration tab, and for your project, click on Standard libraries, edit, and update.

4. As there are breaking changes, new issues may appear in your project.

5. Go to the Configuration tab, and migrate your pattern data according to the [standard pattern libraries migration guide].

6. When the migration is completed, all errors should be resolved.

7. If you face too many errors, consider upgrading step by step, by selecting an earlier version of the standard library in step 2.

8. Go to the Deployment wizard, and on the Validation step, check the generated configuration.

9. Even if you do not face any issues or notice differences any more, check the LTS Migration Guide of the components for new component behavior due to changes in default values.

10. Upgrade your target systems according to the requirements defined in [Nevis Product Lifetime and Platform Support Matrix].

11. For some Nevis components, a database schema upgrade is required. Check the technical documentation of each components for upgrade instructions.

12. Stop the affected components while performing the database schema upgrade.

13. Deploy the project to your target systems.

14. As LTS-21 contains significant improvements, extensively test all use cases with your partners.

Generic Patterns

We cannot offer automatic upgrade for the contents of Generic patterns.

For this reason, upgrading a project which uses generic patterns requires that you also check the component LTS Migration Guides and apply the required changes in relevant patterns.

References

Component	General Upgrade / Installations Instructions	LTS Migration Guide
nevisAppliance	[Software updates]
nevisAdmin 4	[Software Upgrade]
nevisAdmin 4 Standard Pattern Library	[Editing Project Pattern Libraries]
nevisAdmin 3	[Installation and Deployment]
nevisProxy	[Installation and Deployment]
nevisAuth	[Installation]
nevisDetect/nevisAdapt	[Installation]
nevisFIDO (with additional nevisfidocl packages)	See to the [reference guide] for details.	nA
nevisIDM	[Installation]
nevisLogRend	[Installation]
nevisMeta	[Installation]
nevisDataPorter	Migration is not needed
nevisKeybox
Ninja
Ninwin

FAQ

1. What is the deadline for the migration?

2. We recommend upgrading to this new major version within 6 months after it is released, but not later than 12 months, which will be the end of the Maintenance Support period of LTS-2019 (comment: based on LTS definition: [Long Term Support (LTS)]

3. Do you offer automatic migration?

4. Automatic migration is not possible, but when using nevisAdmin 4 the migration effort is minimal.

5. How can I migrate from LTS-19 to RR?

6. Migrate to LTS-21 first and then to RR

7. How to migrate from LTS-19 (after the security patch has expired) to RR?

8. migrate LTS-21, then to RR21.02 , RR21.05, etc.