Skip to content

Commit 0bac443

Browse files
author
Peter Kelly
committed
Add clearer upgrade instructions
1 parent 6ca4bbe commit 0bac443

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

CHANGELOG.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,18 @@ IMPROVEMENTS:
88

99
UPGRADE:
1010

11-
* Remove the previous version of nginx-asg-sync e.g. `dpkg --remove nginx-asg-sync`
12-
* Deploy the new version to your NGINX Plus instance in AWS and install it `dpkg -i nginx-asg-sync_0.2-1-xenial_amd64.deb`
13-
* Update the `/etc/nginx/aws.yaml` to the new format (example in the [configuration section](https://github.com/nginxinc/nginx-asg-sync#nginx-asg-sync-configuration) of the README.md))
14-
* Reload NGINX Plus
11+
The upgrade process requires changing both NGINX Plus configuration and nginx-asg-sync configuration. Below are the recommended steps to follow:
12+
13+
1. Upgrade NGINX Plus to R14 or R15
14+
2. Enable the new API in the NGINX Plus configuration while keeping the upstream_conf and the status API enabled. See an example of configuring the new API in the configuration section, but make sure to keep the upstream_conf and the status API.
15+
3. Reload NGINX Plus to apply the updated configuration
16+
4. Modify the /etc/nginx/aws.yaml file:
17+
* Remove the `upstream_conf_endpoint` and `status_endpoint` fields.
18+
* Add the `api_endpoint` field. See an example in the configuration section of the README.md
19+
5. Download the Release 0.2 nginx-asg-sync package for your OS and upgrade the package using the OS tools (dpkg or rpm).
20+
6. Check the logs of nginx-asg-sync to make sure that it is working properly after the upgrade.
21+
7. Finally remove the upstream_conf and the status API from NGINX Plus configuration.
22+
8. Reload NGINX Plus to apply the updated configuration
1523

1624
Note: the supported versions of NGINX Plus are R14 and higher.
1725

0 commit comments

Comments
 (0)