Skip to content

Commit 125b0d0

Browse files
jantmanjantman
committed
issue #22 - can't do dynamic generation or sphinx-apidoc on RTD, need to commit this to repo until readthedocs/readthedocs.org#1083 is done
1 parent 1b0f4d2 commit 125b0d0

13 files changed

+216
-4
lines changed

‎.gitignore

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,6 @@ coverage.xml
5353

5454
# Sphinx documentation
5555
docs/build/
56-
docs/source/awslimitchecker*.rst
57-
docs/source/modules.rst
58-
docs/source/limits.rst
59-
docs/source/iam_policy.rst
6056

6157
# PyBuilder
6258
target/

‎docs/source/awslimitchecker.checker.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
awslimitchecker.checker module
2+
==============================
3+
4+
.. automodule:: awslimitchecker.checker
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/awslimitchecker.limit.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
awslimitchecker.limit module
2+
============================
3+
4+
.. automodule:: awslimitchecker.limit
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/awslimitchecker.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
awslimitchecker package
2+
=======================
3+
4+
.. automodule:: awslimitchecker
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Subpackages
10+
-----------
11+
12+
.. toctree::
13+
14+
awslimitchecker.services
15+
16+
Submodules
17+
----------
18+
19+
.. toctree::
20+
21+
awslimitchecker.checker
22+
awslimitchecker.limit
23+
awslimitchecker.runner
24+
awslimitchecker.version
25+

‎docs/source/awslimitchecker.runner.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
awslimitchecker.runner module
2+
=============================
3+
4+
.. automodule:: awslimitchecker.runner
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/awslimitchecker.services.base.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
awslimitchecker.services.base module
2+
====================================
3+
4+
.. automodule:: awslimitchecker.services.base
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/awslimitchecker.services.ec2.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
awslimitchecker.services.ec2 module
2+
===================================
3+
4+
.. automodule:: awslimitchecker.services.ec2
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/awslimitchecker.services.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
awslimitchecker.services package
2+
================================
3+
4+
.. automodule:: awslimitchecker.services
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Submodules
10+
----------
11+
12+
.. toctree::
13+
14+
awslimitchecker.services.base
15+
awslimitchecker.services.ec2
16+

‎docs/source/awslimitchecker.services.vpc.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
awslimitchecker.services.vpc module
2+
===================================
3+
4+
.. automodule:: awslimitchecker.services.vpc
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/awslimitchecker.version.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
awslimitchecker.version module
2+
==============================
3+
4+
.. automodule:: awslimitchecker.version
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/iam_policy.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
2+
.. _iam_policy:
3+
4+
Required IAM Permissions
5+
========================
6+
7+
Below is the sample IAM policy from this version of awslimitchecker, listing the IAM
8+
permissions required for it to function correctly:
9+
10+
.. code-block:: json
11+
12+
{
13+
"Statement": [
14+
{
15+
"Action": [
16+
"ec2:DescribeInstances",
17+
"ec2:DescribeReservedInstances",
18+
"ec2:DescribeSecurityGroups",
19+
"ec2:DescribeVolumes"
20+
],
21+
"Effect": "Allow",
22+
"Resource": "*"
23+
}
24+
],
25+
"Version": "2012-10-17"
26+
}
27+

‎docs/source/limits.rst

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
2+
.. _limits:
3+
4+
Supported Limits
5+
================
6+
7+
.. _limits.trusted_advisor:
8+
9+
Trusted Advisor Data
10+
---------------------
11+
12+
TODO
13+
14+
.. _limits.checks:
15+
16+
Current Checks
17+
---------------
18+
19+
The section below lists every limit that this version of awslimitchecker knows
20+
how to check, and its hard-coded default value (per AWS documentation).
21+
22+
EC2
23+
++++
24+
25+
================================================= =====
26+
Limit Default
27+
================================================= =====
28+
EC2-Classic Elastic IPs 5
29+
EC2-VPC Elastic IPs 5
30+
General Purpose (SSD) volume storage (TiB) 20
31+
Magnetic volume storage (TiB) 20
32+
Provisioned IOPS 40000
33+
Provisioned IOPS (SSD) volume storage (TiB) 20
34+
Rules per VPC security group 50
35+
Running On-Demand EC2 instances 20
36+
Running On-Demand c1.medium instances 20
37+
Running On-Demand c1.xlarge instances 20
38+
Running On-Demand c3.2xlarge instances 20
39+
Running On-Demand c3.4xlarge instances 20
40+
Running On-Demand c3.8xlarge instances 20
41+
Running On-Demand c3.large instances 20
42+
Running On-Demand c3.xlarge instances 20
43+
Running On-Demand c4.2xlarge instances 20
44+
Running On-Demand c4.4xlarge instances 10
45+
Running On-Demand c4.8xlarge instances 5
46+
Running On-Demand c4.large instances 20
47+
Running On-Demand c4.xlarge instances 20
48+
Running On-Demand cc2.8xlarge instances 20
49+
Running On-Demand cg1.4xlarge instances 2
50+
Running On-Demand cr1.8xlarge instances 2
51+
Running On-Demand d2.2xlarge instances 20
52+
Running On-Demand d2.4xlarge instances 10
53+
Running On-Demand d2.8xlarge instances 5
54+
Running On-Demand d2.xlarge instances 20
55+
Running On-Demand g2.2xlarge instances 5
56+
Running On-Demand g2.8xlarge instances 2
57+
Running On-Demand hi1.4xlarge instances 2
58+
Running On-Demand hs1.8xlarge instances 2
59+
Running On-Demand i2.2xlarge instances 8
60+
Running On-Demand i2.4xlarge instances 4
61+
Running On-Demand i2.8xlarge instances 2
62+
Running On-Demand i2.xlarge instances 8
63+
Running On-Demand m1.large instances 20
64+
Running On-Demand m1.medium instances 20
65+
Running On-Demand m1.small instances 20
66+
Running On-Demand m1.xlarge instances 20
67+
Running On-Demand m2.2xlarge instances 20
68+
Running On-Demand m2.4xlarge instances 20
69+
Running On-Demand m2.xlarge instances 20
70+
Running On-Demand m3.2xlarge instances 20
71+
Running On-Demand m3.large instances 20
72+
Running On-Demand m3.medium instances 20
73+
Running On-Demand m3.xlarge instances 20
74+
Running On-Demand m4.2xlarge instances 20
75+
Running On-Demand m4.4xlarge instances 20
76+
Running On-Demand m4.8xlarge instances 20
77+
Running On-Demand m4.large instances 20
78+
Running On-Demand m4.xlarge instances 20
79+
Running On-Demand r3.2xlarge instances 20
80+
Running On-Demand r3.4xlarge instances 10
81+
Running On-Demand r3.8xlarge instances 5
82+
Running On-Demand r3.large instances 20
83+
Running On-Demand r3.xlarge instances 20
84+
Running On-Demand t1.micro instances 20
85+
Running On-Demand t2.medium instances 20
86+
Running On-Demand t2.micro instances 20
87+
Running On-Demand t2.small instances 20
88+
Security groups per VPC 100
89+
VPC security groups per elastic network interface 5
90+
================================================= =====
91+
92+

‎docs/source/modules.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
awslimitchecker
2+
===============
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
awslimitchecker

0 commit comments

Comments
 (0)