@@ -229,28 +229,37 @@ Message Footer
229229""""""""""""""
230230
231231All breaking changes need to be mentioned in the footer with the description of the
232- change, the justification behind the change and any migration notes required. For example:
232+ change, the justification behind the change and any migration notes required. Any methods
233+ that maintainers can use to test these changes should be placed in the footer as well. For
234+ example:
233235
234236.. code-block :: console
235237
238+ TESTING: to test this change, bring up a new cluster and run the following
239+ when the controller comes online:
240+
241+ $ vagrant ssh -c "curl localhost:8000"
242+
243+ you should see an HTTP response from the controller.
244+
236245 BREAKING CHANGE: the controller no longer listens on port 80. It now listens on
237- port 8000, with the router redirecting requests on port 80 to the controller. To
238- migrate to this change, SSH into your controller and run:
246+ port 8000, with the router redirecting requests on port 80 to the controller. To
247+ migrate to this change, SSH into your controller and run:
239248
240249 $ docker kill deis-controller
241250 $ docker rm deis-controller
242251
243- and then restart the controller on port 8000:
252+ and then restart the controller on port 8000:
244253
245254 $ docker run -d -p 8000:8000 -e ETCD=<etcd_endpoint> -e HOST=<host_ip> \
246255 -e PORT=8000 -name deis-controller deis/controller
247256
248- now you can start the proxy component by running:
257+ now you can start the proxy component by running:
249258
250259 $ docker run -d -p 80:80 -e ETCD=<etcd_endpoint> -e HOST=<host_ip> -e PORT=80 \
251260 -name deis-router deis/router
252261
253- The router should then start proxying requests from port 80 to the controller.
262+ the router should then start proxying requests from port 80 to the controller.
254263
255264 Referencing Issues
256265""""""""""""""""""
0 commit comments