This article will describe the steps that you need to take when making a change to the service schema and how to upgrade the SMS Configuration. As part of this guide we will explain which upgrade rules need to be created and how to write them.
Note: This is a working document which will continue to evolve as as fill in more detail. If you have comments or suggestions, please feel free to make them.
Currently there are two ways to change the service schema in AM:
When a change is made to the schema of AM, there needs to be a corresponding change to AM's configuration. New installations of AM will will produce the latest configuration, however existing installations of AM will have configuration that is out of date. The role of an upgrade rule in this case is to upgrade the existing configuration so that it matches the latest schema of AM.
Currently there are 3 ways a customer might upgrade AM's configuration depending on the deployment model they are using:
org.forgerock.openam.upgrade.steps.UpgradeStep
Amster based Deployments: These customers have their configuration as exported Amster files. These configuration files will need to be upgraded using the openam-config-upgrader
. Developers implementing these rules will need to write new Amster rules to perform this upgrade.
openam-config-upgrader
.For both Amster and FBC, upgrade rules only need to be written for changes to the existing configuration files i.e. not when additions are made. This is because for both Amster (via a new AM install) and FBC (via a set of base configuration files shipped it the AM docker image) any new configuration files will automatically be included.
To summarise when changes are needed:
Change Operation | Amster | FBC |
---|---|---|
Modification | ✅ | ✅ |
Deletion | ✅ | ✅ |
Addition | ❌ | ❌ |
As part of a schema change the following tasks need to be completed
The openam-config-upgrader is released with AM and is the tool for upgrading both Amster-export and FBC AM configuration.