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:
- In the xml schema files that use the sms.dtd
- Through annotations on POJO's in the AM codebase
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:
- LDAP SMS: These customers have a deployment based on storing their configuration in an LDAP database. They will upgrade their configuration using the AM upgrader. Developers creating these rules will implement
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.
- File-based Configuration Deployments: Starting with AM 7.0.0, customers will be able to store their configuration in file-based configuration files on disk. Similar to Amster files in some ways, these new files will also be upgraded using the
Checklist of required actions
As part of a schema change the following tasks need to be completed
- Create an upgrade step for: AM Upgrader
- Create upgrade rules for: Amster
- Create upgrade rules for: File Based Config
The openam-config-upgrader is released with AM and is the tool for upgrading both Amster-export and FBC AM configuration.