Configuration changes commit process
The LMI uses a two-stage commit process when you make changes to the appliance.
- Stage 1
- Changes are made using the LMI and saved to a staging area.
- Stage 2
- The user explicitly deploys the changes into production.
Multiple changes can exist in a pending state at the same time. They are committed or rolled back together when a user deploys or rolls back these changes.
Pending changes are managed on a per user identity basis. This means that changes made by one user identity will not be visible to another user identity until the changes are deployed. As there is no validation or merging of changes that are made by different user identities to the same component, changes that are made by one user can potentially overwrite changes that are made by another user.
Any changes that affect running reverse proxy instances require a restart of the effected instances before the changes can take effect. Certain appliance updates require either the appliance or the web server to be restarted before the changes can take effect. When one or more of these updates are made alongside other reverse proxy updates, an additional step is required to deploy the reverse proxy updates. We must:
- Deploy all updates.
- Restart the appliance or the web server.
- Deploy all remaining updates.
If there are conflicts between the pending changes and the production files, then all pending changes are automatically rolled back and the production files remain unchanged.
Web service
- Deploy the pending configuration changes
- URL
https://{appliance_hostname}/isam/pending_changes/deploy- Method
- Parameters
- N/A
- Response
HTTP response code and JSON error response where applicable.
- Example
Request:
GET https://{appliance_hostname}/isam/pending_changes/deploy
Response:
200 ok
Roll back the pending configuration changes
- URL
https://{appliance_hostname}/isam/pending_changes/forget- Method
- Parameters
- N/A
- Response
HTTP response code and JSON error response where applicable.
- Example
Request:
GET https://{appliance_hostname}/isam/pending_changes/forget
Response:
200 ok
Retrieve the number of outstanding changes
- URL
https://{appliance_hostname}/isam/pending_changes/count- Method
- Parameters
- N/A
- Response
HTTP response code and JSON data representing the number of pending changes.
- Example
Request:
GET https://{appliance_hostname}/isam/pending_changes/count
Response:
{"count": 3}
Retrieve the list of outstanding changes
- URL
https://{appliance_hostname}/isam/pending_changes- Method
- Parameters
- N/A
- Response
HTTP response code and JSON data representing the list of pending changes.
- Example
Request:
GET https://{appliance_hostname}/isam/pending_changes
Response:
200 ok [{ "id": 0, "policy": "SSL Certificates", "user": "admin", "date": "2012-11-05T11:22:20+10:00" }]
Local management interface
When there are pending changes, a warning message is displayed at the top of the main pane. To deploy or roll back the pending changes:
- Click the Click here to review the changes or apply them to the system link within the warning message.
- In the Deploy Pending Changes page:
- To view the details of changes that are made to a particular module, click the link to that module.
- To deploy the changes, click Deploy.
- To abandon the changes, click Roll Back.
- To close the pop-up page without any actions against the changes, click Cancel.
Parent topic: Manage the appliance
Parent topic: web reverse proxy administration