README.md in capistrano-asg-rolling-0.1.0 vs README.md in capistrano-asg-rolling-0.2.0
- old
+ new
@@ -9,12 +9,12 @@
Instead of deploying to live servers, capistrano-asg-rolling will create a temporary instance for deployment and then trigger an instance refresh to perform a rolling update of the Auto Scaling Group(s). In more detail, during deployment it will:
- Launch an instance from the AMI defined in the Launch Template of the Auto Scaling Group(s).
- Deploy your application to the launched instances.
- After deployment, stop the instances and create an AMI for each instance.
-- Create new Launch Template versions with the new AMIs.
-- Trigger Instance Refresh on the Auto Scaling Group(s) to perform an rolling update.
+- Create new Launch Template versions for the new AMIs.
+- Trigger Instance Refresh on the Auto Scaling Group(s) to perform a rolling update.
- Delete any outdated Launch Template versions, AMIs and snapshots created by previous deployments.
- Terminate the no longer needed instances.
## Caveats
@@ -24,28 +24,20 @@
#### Launch Templates
This gem depends on Auto Scaling Groups with Launch Templates. Using an Auto Scaling Group with a Launch Configuration is not supported, and will raise an `Capistrano::ASG::Rolling::NoLaunchTemplate`.
-Make sure you have configured the Auto Scaling Groups with the Launch Template version set to `Latest` so instance refresh will work.
+Instance refresh uses the desired configuration to update the Launch Template version of the Auto Scaling Group after a succesful deployment. Setting the Launch Template version to `Latest` on the Auto Scaling Group is not needed.
#### Experimental
This gem is experimental, it works for our configuration / use case, but might not for yours.
The configuration options are not considered stable and might be changed or removed in future releases.
The gem could have a better / fancier name.
-#### Bugs
-
-Currently all Launch Template versions and AMIs will be deleted, also when not created by this gem.
-
-When an Instance refresh is already in progress, the deployment will fail with an `Aws::AutoScaling::Errors::InstanceRefreshInProgress`.
-
-Documentation is incomplete.
-
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -121,10 +113,10 @@
Now start a deployment with `cap <stage> deploy` and enjoy.
### Deploy without rolling update
-There might be cases where you just want to deploy your code to the servers in the Auto Scaling Group(s) without a rolling update.
+There might be cases where you just want to deploy your code to the servers in the Auto Scaling Group(s) without a rolling update.
You can configure rolling updates per autoscaling group by using the `rolling` option:
```ruby
# config/deploy/<stage>.rb