Skip to content

Commit

Permalink
rebuild docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@jantman
jantman committed Dec 7, 2020
1 parent 704b79c commit 53c11b6
Show file tree
Hide file tree
Showing 8 changed files with 136 additions and 60 deletions.
9 changes: 3 additions & 6 deletions docs/build_generated_docs.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ def limits_for_ec2():
regions still use the old per-instance-type limits. Please see the sections
for either :ref:`limits.ec2-standard` or :ref:`limits.ec2-nonvcpu` for
details.
""")
limit_info += '.. _limits.ec2-standard:\n\n'
limit_info += "EC2 - Standard Regions\n"
Expand All @@ -180,10 +180,10 @@ def limits_for_ec2():
(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.
**Important:** The limits for **Running On-Demand Instances** are now
measured in vCPU count per instance family, not instance count per instance
type.
type.
""") + "\n"
limit_info += "\n"
limit_info += format_limits_for_service(
Expand Down Expand Up @@ -299,9 +299,6 @@ def build_runner_examples():
'--limit="AutoScaling/Launch configurations"=456',
'-l',
],
'check_thresholds': ['awslimitchecker', '--no-color'],
'check_thresholds_custom': ['awslimitchecker', '-W', '97',
'--critical=98', '--no-color'],
'iam_policy': ['awslimitchecker', '--iam-policy'],
'list_metrics': ['awslimitchecker', '--list-metrics-providers'],
'list_alerts': ['awslimitchecker', '--list-alert-providers'],
Expand Down
8 changes: 8 additions & 0 deletions docs/source/awslimitchecker.services.eks.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
awslimitchecker.services.eks module
===================================

.. automodule:: awslimitchecker.services.eks
:members:
:undoc-members:
:show-inheritance:
:private-members:
8 changes: 8 additions & 0 deletions docs/source/awslimitchecker.services.kinesis.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
awslimitchecker.services.kinesis module
=======================================

.. automodule:: awslimitchecker.services.kinesis
:members:
:undoc-members:
:show-inheritance:
:private-members:
2 changes: 2 additions & 0 deletions docs/source/awslimitchecker.services.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,13 @@ Submodules
awslimitchecker.services.ec2
awslimitchecker.services.ecs
awslimitchecker.services.efs
awslimitchecker.services.eks
awslimitchecker.services.elasticache
awslimitchecker.services.elasticbeanstalk
awslimitchecker.services.elb
awslimitchecker.services.firehose
awslimitchecker.services.iam
awslimitchecker.services.kinesis
awslimitchecker.services.lambdafunc
awslimitchecker.services.rds
awslimitchecker.services.redshift
Expand Down
12 changes: 3 additions & 9 deletions docs/source/cli_usage.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -461,8 +461,6 @@ threshold only, and another has crossed the critical threshold):
VPC/NAT Gateways per AZ (limit 5) CRITICAL: us-east-1d=5, us-east-1c= (...)
VPC/Virtual private gateways (limit 5) WARNING: 4
.. _cli_usage.threshold_overrides:

Set Custom Thresholds
Expand All @@ -482,8 +480,6 @@ To set the warning threshold of 50% and a critical threshold of 75% when checkin
S3/Buckets (limit 100) CRITICAL: 946
VPC/NAT Gateways per AZ (limit 5) CRITICAL: us-east-1d=5, us-east-1c= (...)
You can also set custom thresholds on a per-limit basis using the
``--threshold-override-json`` CLI option, which accepts the path to a JSON file
(local or an s3:// URL) matching the format described in
Expand Down Expand Up @@ -530,17 +526,15 @@ Using a command like:
.. code-block:: console
(venv)$ awslimitchecker -W 97 --critical=98 --no-color --threshold-override-json=s3://bucketname/path/overrides.json
DynamoDB/Local Secondary Indexes (limit 5) CRITICAL: some_app_name_here=5
DynamoDB/Local Secondary Indexes (limit 5) CRITICAL: some_app_name (...)
DynamoDB/Tables Per Region (limit 256) CRITICAL: 554
EC2/Rules per VPC security group (limit 50) CRITICAL: sg-aaaaaaaa=49, sg-bbbbb (...)
EC2/Security groups per VPC (limit 500) CRITICAL: vpc-cccccccc=726, vpc-c (...)
EC2/Rules per VPC security group (limit 50) CRITICAL: sg-cccccccc=49, sg-eeeee (...)
EC2/Security groups per VPC (limit 500) CRITICAL: vpc-dddddddd=726, vpc-c (...)
(...)
RDS/VPC Security Groups (limit 5) CRITICAL: 5
S3/Buckets (limit 100) CRITICAL: 946
VPC/NAT Gateways per AZ (limit 5) CRITICAL: us-east-1d=5, us-east-1c= (...)
.. _cli_usage.metrics:

Enable Metrics Provider
Expand Down
34 changes: 31 additions & 3 deletions docs/source/cli_usage.rst.template
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,18 @@ usage value, or both; this functionality is not currently present in the command
To check all limits against their thresholds (in this example, one limit has crossed the warning
threshold only, and another has crossed the critical threshold):

{check_thresholds}
.. code-block:: console

(venv)$ awslimitchecker --no-color
CloudFormation/Stacks (limit 4000) WARNING: 3396
DynamoDB/Local Secondary Indexes (limit 5) CRITICAL: some_app_name (...)
DynamoDB/Tables Per Region (limit 256) CRITICAL: 554
EBS/Active snapshots (limit 40000.0) WARNING: 33387
EC2/Rules per VPC security group (limit 50) CRITICAL: sg-aaaaaaaa=50, sg-bbbb (...)
(...)
VPC/Entries per route table (limit 50) WARNING: rtb-aaaaaaaa=43, rtb-bbbb (...)
VPC/NAT Gateways per AZ (limit 5) CRITICAL: us-east-1d=5, us-east-1c= (...)
VPC/Virtual private gateways (limit 5) WARNING: 4

.. _cli_usage.threshold_overrides:

Expand All @@ -196,7 +207,17 @@ Set Custom Thresholds

To set the warning threshold of 50% and a critical threshold of 75% when checking limits:

{check_thresholds_custom}
.. code-block:: console

(venv)$ awslimitchecker -W 97 --critical=98 --no-color
DynamoDB/Local Secondary Indexes (limit 5) CRITICAL: some_app_name (...)
DynamoDB/Tables Per Region (limit 256) CRITICAL: 554
EC2/Rules per VPC security group (limit 50) CRITICAL: sg-cccccccc=49, sg-eeeee (...)
EC2/Security groups per VPC (limit 500) CRITICAL: vpc-dddddddd=726, vpc-c (...)
(...)
RDS/VPC Security Groups (limit 5) CRITICAL: 5
S3/Buckets (limit 100) CRITICAL: 946
VPC/NAT Gateways per AZ (limit 5) CRITICAL: us-east-1d=5, us-east-1c= (...)

You can also set custom thresholds on a per-limit basis using the
``--threshold-override-json`` CLI option, which accepts the path to a JSON file
Expand All @@ -212,7 +233,14 @@ Using a command like:
.. code-block:: console

(venv)$ awslimitchecker -W 97 --critical=98 --no-color --threshold-override-json=s3://bucketname/path/overrides.json
{check_thresholds_custom-output-only}
DynamoDB/Local Secondary Indexes (limit 5) CRITICAL: some_app_name (...)
DynamoDB/Tables Per Region (limit 256) CRITICAL: 554
EC2/Rules per VPC security group (limit 50) CRITICAL: sg-cccccccc=49, sg-eeeee (...)
EC2/Security groups per VPC (limit 500) CRITICAL: vpc-dddddddd=726, vpc-c (...)
(...)
RDS/VPC Security Groups (limit 5) CRITICAL: 5
S3/Buckets (limit 100) CRITICAL: 946
VPC/NAT Gateways per AZ (limit 5) CRITICAL: us-east-1d=5, us-east-1c= (...)

.. _cli_usage.metrics:

Expand Down
6 changes: 6 additions & 0 deletions docs/source/iam_policy.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,11 @@ services that do not affect the results of this program.
"ecs:DescribeServices",
"ecs:ListClusters",
"ecs:ListServices",
"eks:DescribeCluster",
"eks:DescribeFargateProfile",
"eks:ListClusters",
"eks:ListFargateProfiles",
"eks:ListNodegroups",
"elasticache:DescribeCacheClusters",
"elasticache:DescribeCacheParameterGroups",
"elasticache:DescribeCacheSecurityGroups",
Expand All @@ -86,6 +91,7 @@ services that do not affect the results of this program.
"elasticloadbalancing:DescribeTargetGroups",
"firehose:ListDeliveryStreams",
"iam:GetAccountSummary",
"kinesis:DescribeLimits",
"lambda:GetAccountSettings",
"rds:DescribeAccountAttributes",
"rds:DescribeDBInstances",
Expand Down
117 changes: 75 additions & 42 deletions docs/source/limits.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,26 +167,26 @@ number of instances you see in the Console or API.

**Important:** The limits for **Running On-Demand Instances** are now
measured in vCPU count per instance family, not instance count per instance
type.
type.


==================================================================== =============== ======== ======= ====
Limit Trusted Advisor Quotas API Default
==================================================================== =============== ======== ======= ====
Elastic IP addresses (EIPs) |check| |check| |check| 5
Elastic IP addresses (EIPs) |check| 5
Max active spot fleets per region 1000
Max launch specifications per spot fleet 50
Max spot instance requests per region 20
Max target capacity for all spot fleets in region 5000
Max target capacity per spot fleet 3000
Rules per VPC security group 60
Rules per VPC security group |check| 60
Running On-Demand All F instances |check| 128
Running On-Demand All G instances |check| 128
Running On-Demand All P instances |check| 128
Running On-Demand All Standard (A, C, D, H, I, M, R, T, Z) instances |check| 1152
Running On-Demand All X instances |check| 128
Security groups per VPC 500
VPC Elastic IP addresses (EIPs) |check| |check| |check| 5
VPC Elastic IP addresses (EIPs) |check| 5
VPC security groups per Region |check| 2500
VPC security groups per elastic network interface |check| 5
==================================================================== =============== ======== ======= ====

Expand Down Expand Up @@ -516,6 +516,24 @@ Limit Trusted Advisor Quotas API Default
File systems |check| 1000
============ =============== ======== ======= ====

.. _limits.EKS:

EKS
----

============================================== =============== ======== ======= ===
Limit Trusted Advisor Quotas API Default
============================================== =============== ======== ======= ===
Clusters |check| 100
Control plane security groups per cluster |check| 4
Fargate profiles per cluster |check| 10
Label pairs per Fargate profile selector |check| 5
Managed node groups per cluster |check| 30
Nodes per managed node group |check| 100
Public endpoint access CIDR ranges per cluster |check| 40
Selectors per Fargate profile |check| 5
============================================== =============== ======== ======= ===

.. _limits.ELB:

ELB
Expand Down Expand Up @@ -544,11 +562,11 @@ ElastiCache
======================== =============== ======== ======= ===
Limit Trusted Advisor Quotas API Default
======================== =============== ======== ======= ===
Nodes 100
Nodes 300
Nodes per Cluster 20
Parameter Groups 20
Parameter Groups 150
Security Groups 50
Subnet Groups 50
Subnet Groups 150
Subnets per subnet group 20
======================== =============== ======== ======= ===

Expand Down Expand Up @@ -593,6 +611,17 @@ Server certificates |check| |check| |check| 20
Users |check| |check| |check| 5000
====================== =============== ======== ======= =====

.. _limits.Kinesis:

Kinesis
--------

================= =============== ======== ======= ===
Limit Trusted Advisor Quotas API Default
================= =============== ======== ======= ===
Shards per Region |check| |check| 500
================= =============== ======== ======= ===

.. _limits.Lambda:

Lambda
Expand All @@ -614,25 +643,29 @@ Unreserved Concurrent Executions |check| 1000
RDS
----

============================ =============== ======== ======= ======
Limit Trusted Advisor Quotas API Default
============================ =============== ======== ======= ======
DB Cluster Parameter Groups |check| |check| |check| 50
DB Clusters |check| |check| |check| 40
DB instances |check| |check| |check| 40
DB parameter groups |check| |check| |check| 50
DB security groups |check| |check| |check| 25
DB snapshots per user |check| |check| 100
Event Subscriptions |check| |check| |check| 20
Max auths per security group |check| |check| |check| 20
Option Groups |check| |check| 20
Read replicas per master |check| |check| |check| 5
Reserved Instances |check| |check| 40
Storage quota (GB) |check| |check| |check| 100000
Subnet Groups |check| |check| |check| 50
Subnets per Subnet Group |check| |check| |check| 20
VPC Security Groups 5
============================ =============== ======== ======= ======
=============================== =============== ======== ======= ======
Limit Trusted Advisor Quotas API Default
=============================== =============== ======== ======= ======
Custom Endpoints Per DB Cluster |check| 5
DB Cluster Parameter Groups |check| |check| 50
DB Cluster Roles |check| 5
DB Clusters |check| |check| 40
DB Instance Roles |check| 5
DB instances |check| |check| 40
DB parameter groups |check| |check| 50
DB security groups |check| |check| 25
DB snapshots per user |check| 100
Event Subscriptions |check| |check| 20
Manual Cluster Snapshots |check| 100
Max auths per security group |check| |check| 20
Option Groups |check| |check| 20
Read replicas per master |check| |check| 5
Reserved Instances |check| |check| 40
Storage quota (GB) |check| |check| 100000
Subnet Groups |check| |check| 50
Subnets per Subnet Group |check| |check| 20
VPC Security Groups 5
=============================== =============== ======== ======= ======

.. _limits.Redshift:

Expand Down Expand Up @@ -661,7 +694,7 @@ zone. As such, each zone may have a different limit value.
Limit Trusted Advisor Quotas API Default
================================ =============== ======== ======= =====
Record sets per hosted zone |check| 10000
VPC associations per hosted zone |check| 100
VPC associations per hosted zone 100
================================ =============== ======== ======= =====

.. _limits.S3:
Expand All @@ -683,28 +716,28 @@ SES
=================== =============== ======== ======= ===
Limit Trusted Advisor Quotas API Default
=================== =============== ======== ======= ===
Daily sending quota |check| |check| 200
Daily sending quota |check| 200
=================== =============== ======== ======= ===

.. _limits.VPC:

VPC
----

============================= =============== ======== ======= ===
============================= =============== ======== ======= ====
Limit Trusted Advisor Quotas API Default
============================= =============== ======== ======= ===
Entries per route table 50
Internet gateways |check| |check| 5
NAT Gateways per AZ 5
Network ACLs per VPC 200
Network interfaces per Region |check| 350
Route tables per VPC 200
Rules per network ACL 20
Subnets per VPC 200
VPCs |check| |check| 5
Virtual private gateways 5
============================= =============== ======== ======= ===
============================= =============== ======== ======= ====
Entries per route table |check| 50
Internet gateways |check| 5
NAT Gateways per AZ |check| 5
Network ACLs per VPC |check| 200
Network interfaces per Region |check| 5000
Route tables per VPC |check| 200
Rules per network ACL |check| 20
Subnets per VPC |check| 200
VPCs |check| 5
Virtual private gateways 5
============================= =============== ======== ======= ====



Expand Down

0 comments on commit 53c11b6

Please sign in to comment.