fixes #194 - clarify reserved instances in docs

jantman · Sep 24, 2016 · 446005a · 446005a
1 parent 6a1f58e
commit 446005a
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 2 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -25,6 +25,7 @@ This release requires the following new IAM permissions to function:
 * `#202 <https://github.com/jantman/awslimitchecker/issues/202>`_ - Adds management of integration test IAM policy via Terraform.
 * `#211 <https://github.com/jantman/awslimitchecker/issues/211>`_ - Add working download stats to README and docs
 * Fix broken landscape.io badges in README and docs
+* `#194 <https://github.com/jantman/awslimitchecker/issues/194>`_ - On Limits page of docs, clarify that Running On-Demand Instances does not include Reserved Instances.
 
 0.5.0 (2016-07-06)
 ------------------

diff --git a/docs/build_generated_docs.py b/docs/build_generated_docs.py
@@ -115,6 +115,15 @@ def build_limits(checker):
             spot instance or fleet usage or limits, please
             `open an issue on GitHub <https://github.com/jantman/awslimitchecker
             /issues/new>`_""") + "\n"
+            limit_info += "\n" + dedent("""
+            **Note on On-Demand vs Reserved Instances:** The EC2 limits for
+            "Running On-Demand" EC2 Instances apply only to On-Demand instances,
+            not Reserved Instances. If you list all EC2 instances that are
+            running in the Console or API, you'll get back instances of all types
+            (On-Demand, Reserved, etc.). The value that awslimitchecker reports
+            for Running On-Demand Instances current usage will *not* match the
+            number of instances you see in the Console or API.
+            """) + "\n"
         limit_info += "\n"
         # build a dict of the limits
         slimits = {}

diff --git a/docs/source/limits.rst b/docs/source/limits.rst
@@ -54,6 +54,8 @@ updated from Trusted Advisor:
 
   * Running On-Demand c4.2xlarge instances
 
+  * Running On-Demand c4.large instances
+
   * Running On-Demand m1.medium instances
 
   * Running On-Demand m3.2xlarge instances
@@ -64,6 +66,8 @@ updated from Trusted Advisor:
 
   * Running On-Demand m3.xlarge instances
 
+  * Running On-Demand m4.2xlarge instances
+
   * Running On-Demand m4.4xlarge instances
 
   * Running On-Demand m4.large instances
@@ -275,6 +279,16 @@ spot instance or fleet usage or limits, please
 `open an issue on GitHub <https://github.com/jantman/awslimitchecker
 /issues/new>`_
 
+
+**Note on On-Demand vs Reserved Instances:** The EC2 limits for
+"Running On-Demand" EC2 Instances apply only to On-Demand instances,
+not Reserved Instances. If you list all EC2 instances that are
+running in the Console or API, you'll get back instances of all types
+(On-Demand, Reserved, etc.). The value that awslimitchecker reports
+for Running On-Demand Instances current usage will *not* match the
+number of instances you see in the Console or API.
+
+
 ============================================================== ====
 Limit                                                          Default
 ============================================================== ====
@@ -296,7 +310,7 @@ Running On-Demand c3.xlarge instances :sup:`(TA)`              20
 Running On-Demand c4.2xlarge instances :sup:`(TA)`             20  
 Running On-Demand c4.4xlarge instances                         10  
 Running On-Demand c4.8xlarge instances                         5   
-Running On-Demand c4.large instances                           20  
+Running On-Demand c4.large instances :sup:`(TA)`               20  
 Running On-Demand c4.xlarge instances                          20  
 Running On-Demand cc2.8xlarge instances                        20  
 Running On-Demand cg1.4xlarge instances                        2   
@@ -325,7 +339,7 @@ Running On-Demand m3.large instances :sup:`(TA)`               20
 Running On-Demand m3.medium instances :sup:`(TA)`              20  
 Running On-Demand m3.xlarge instances :sup:`(TA)`              20  
 Running On-Demand m4.10xlarge instances                        5   
-Running On-Demand m4.2xlarge instances                         20  
+Running On-Demand m4.2xlarge instances :sup:`(TA)`             20  
 Running On-Demand m4.4xlarge instances :sup:`(TA)`             10  
 Running On-Demand m4.large instances :sup:`(TA)`               20  
 Running On-Demand m4.xlarge instances :sup:`(TA)`              20