diff --git a/docs/administration/index.rst b/docs/administration/index.rst index fff50c45..9a1846e2 100644 --- a/docs/administration/index.rst +++ b/docs/administration/index.rst @@ -223,35 +223,17 @@ If you are not using PING you do not need to configure any of these options -AWS Configuration -================= +AWS Plugin Configuration +======================== In order for Lemur to manage it's own account and other accounts we must ensure it has the correct AWS permissions. .. note:: AWS usage is completely optional. Lemur can upload, find and manage SSL certificates in AWS. But is not required to do so. -AWS Configuration Options -------------------------- - -.. data:: AWS_ACCOUNT_MAPPINGS - :noindex: - - Lemur maintains it's own internal table of AWS accounts with their alias and account numbers, this variable is used during setup to bootstrap - your particular enviroment. - - Defaults to ``{}``. - - :: - - AWS_ACCOUNT_MAPPINGS = { - 'awsaccountalias': 111111111111 - } - - Setting up IAM roles -------------------- -Lemur uses boto heavily to talk to all the AWS resources it manages. By default it uses the on-instance credentials to make the necessary calls. +Lemur's aws plugin uses boto heavily to talk to all the AWS resources it manages. By default it uses the on-instance credentials to make the necessary calls. In order to limit the permissions we will create a new two IAM roles for Lemur. You can name them whatever you would like but for example sake we will be calling them LemurInstanceProfile and Lemur. @@ -554,5 +536,3 @@ These permissions are applied to the user upon login and refreshed on every requ .. seealso:: `Flask-Principal `_ - - diff --git a/docs/developer/internals/lemur.auth.rst b/docs/developer/internals/lemur.auth.rst index 5f84d19c..ab505a29 100644 --- a/docs/developer/internals/lemur.auth.rst +++ b/docs/developer/internals/lemur.auth.rst @@ -5,6 +5,7 @@ auth Package ------------------------- .. automodule:: lemur.auth.permissions + :noindex: :members: :undoc-members: :show-inheritance: @@ -13,6 +14,7 @@ auth Package --------------------- .. automodule:: lemur.auth.service + :noindex: :members: :undoc-members: :show-inheritance: @@ -21,7 +23,7 @@ auth Package ------------------- .. automodule:: lemur.auth.views + :noindex: :members: :undoc-members: :show-inheritance: - diff --git a/docs/developer/internals/lemur.authorities.rst b/docs/developer/internals/lemur.authorities.rst index a274642c..cb0f7ad3 100644 --- a/docs/developer/internals/lemur.authorities.rst +++ b/docs/developer/internals/lemur.authorities.rst @@ -5,6 +5,7 @@ authorities Package -------------------- .. automodule:: lemur.authorities.models + :noindex: :members: :undoc-members: :show-inheritance: @@ -13,6 +14,7 @@ authorities Package --------------------- .. automodule:: lemur.authorities.service + :noindex: :members: :undoc-members: :show-inheritance: @@ -21,7 +23,7 @@ authorities Package ------------------- .. automodule:: lemur.authorities.views + :noindex: :members: :undoc-members: :show-inheritance: - diff --git a/docs/developer/internals/lemur.common.rst b/docs/developer/internals/lemur.common.rst index 45102cd8..08cdea1e 100644 --- a/docs/developer/internals/lemur.common.rst +++ b/docs/developer/internals/lemur.common.rst @@ -5,6 +5,7 @@ common Package -------------------- .. automodule:: lemur.common.health + :noindex: :members: :undoc-members: :show-inheritance: @@ -13,6 +14,7 @@ common Package ---------------------- .. automodule:: lemur.common.managers + :noindex: :members: :undoc-members: :show-inheritance: @@ -21,7 +23,7 @@ common Package ------------------- .. automodule:: lemur.common.utils + :noindex: :members: :undoc-members: :show-inheritance: - diff --git a/docs/developer/internals/lemur.destinations.rst b/docs/developer/internals/lemur.destinations.rst index f21b3149..2ea27858 100644 --- a/docs/developer/internals/lemur.destinations.rst +++ b/docs/developer/internals/lemur.destinations.rst @@ -5,6 +5,7 @@ destinations Package -------------------- .. automodule:: lemur.destinations.models + :noindex: :members: :undoc-members: :show-inheritance: @@ -13,6 +14,7 @@ destinations Package --------------------- .. automodule:: lemur.destinations.service + :noindex: :members: :undoc-members: :show-inheritance: @@ -21,7 +23,7 @@ destinations Package ------------------- .. automodule:: lemur.destinations.views + :noindex: :members: :undoc-members: :show-inheritance: - diff --git a/docs/developer/internals/lemur.domains.rst b/docs/developer/internals/lemur.domains.rst index ca798498..609fe13d 100644 --- a/docs/developer/internals/lemur.domains.rst +++ b/docs/developer/internals/lemur.domains.rst @@ -5,6 +5,7 @@ domains Package -------------------- .. automodule:: lemur.domains.models + :noindex: :members: :undoc-members: :show-inheritance: @@ -13,6 +14,7 @@ domains Package --------------------- .. automodule:: lemur.domains.service + :noindex: :members: :undoc-members: :show-inheritance: @@ -21,7 +23,7 @@ domains Package ------------------- .. automodule:: lemur.domains.views + :noindex: :members: :undoc-members: :show-inheritance: - diff --git a/docs/developer/internals/lemur.notifications.rst b/docs/developer/internals/lemur.notifications.rst index e76000c7..4a91cfbf 100644 --- a/docs/developer/internals/lemur.notifications.rst +++ b/docs/developer/internals/lemur.notifications.rst @@ -5,6 +5,7 @@ notifications Package -------------------- .. automodule:: lemur.notifications.models + :noindex: :members: :undoc-members: :show-inheritance: @@ -13,6 +14,7 @@ notifications Package --------------------- .. automodule:: lemur.notifications.service + :noindex: :members: :undoc-members: :show-inheritance: @@ -21,7 +23,7 @@ notifications Package ------------------- .. automodule:: lemur.notifications.views + :noindex: :members: :undoc-members: :show-inheritance: - diff --git a/docs/developer/internals/lemur.plugins.base.rst b/docs/developer/internals/lemur.plugins.base.rst index e65c3390..b1868700 100644 --- a/docs/developer/internals/lemur.plugins.base.rst +++ b/docs/developer/internals/lemur.plugins.base.rst @@ -5,6 +5,7 @@ base Package ------------------- .. automodule:: lemur.plugins.base + :noindex: :members: :undoc-members: :show-inheritance: @@ -13,6 +14,7 @@ base Package --------------------- .. automodule:: lemur.plugins.base.manager + :noindex: :members: :undoc-members: :show-inheritance: @@ -21,7 +23,7 @@ base Package ---------------- .. automodule:: lemur.plugins.base.v1 + :noindex: :members: :undoc-members: :show-inheritance: - diff --git a/docs/developer/internals/lemur.plugins.bases.rst b/docs/developer/internals/lemur.plugins.bases.rst index b6db3d42..eec953b6 100644 --- a/docs/developer/internals/lemur.plugins.bases.rst +++ b/docs/developer/internals/lemur.plugins.bases.rst @@ -5,6 +5,7 @@ bases Package -------------------- .. automodule:: lemur.plugins.bases + :noindex: :members: :undoc-members: :show-inheritance: @@ -13,6 +14,7 @@ bases Package ------------------------- .. automodule:: lemur.plugins.bases.destination + :noindex: :members: :undoc-members: :show-inheritance: @@ -21,6 +23,7 @@ bases Package -------------------- .. automodule:: lemur.plugins.bases.issuer + :noindex: :members: :undoc-members: :show-inheritance: @@ -29,6 +32,7 @@ bases Package -------------------------- .. automodule:: lemur.plugins.bases.notification + :noindex: :members: :undoc-members: :show-inheritance: @@ -37,7 +41,7 @@ bases Package -------------------- .. automodule:: lemur.plugins.bases.source + :noindex: :members: :undoc-members: :show-inheritance: - diff --git a/docs/developer/internals/lemur.plugins.lemur_aws.rst b/docs/developer/internals/lemur.plugins.lemur_aws.rst index 0fd7443c..3a6d70e3 100644 --- a/docs/developer/internals/lemur.plugins.lemur_aws.rst +++ b/docs/developer/internals/lemur.plugins.lemur_aws.rst @@ -5,6 +5,7 @@ lemur_aws Package ------------------------ .. automodule:: lemur.plugins.lemur_aws + :noindex: :members: :undoc-members: :show-inheritance: @@ -13,6 +14,7 @@ lemur_aws Package ----------------- .. automodule:: lemur.plugins.lemur_aws.elb + :noindex: :members: :undoc-members: :show-inheritance: @@ -21,6 +23,7 @@ lemur_aws Package ----------------- .. automodule:: lemur.plugins.lemur_aws.iam + :noindex: :members: :undoc-members: :show-inheritance: @@ -29,6 +32,7 @@ lemur_aws Package -------------------- .. automodule:: lemur.plugins.lemur_aws.plugin + :noindex: :members: :undoc-members: :show-inheritance: @@ -37,7 +41,7 @@ lemur_aws Package ----------------- .. automodule:: lemur.plugins.lemur_aws.sts + :noindex: :members: :undoc-members: :show-inheritance: - diff --git a/docs/developer/internals/lemur.plugins.lemur_cloudca.rst b/docs/developer/internals/lemur.plugins.lemur_cloudca.rst index 7ad7fc84..22d997a5 100644 --- a/docs/developer/internals/lemur.plugins.lemur_cloudca.rst +++ b/docs/developer/internals/lemur.plugins.lemur_cloudca.rst @@ -5,6 +5,7 @@ lemur_cloudca Package ---------------------------- .. automodule:: lemur.plugins.lemur_cloudca + :noindex: :members: :undoc-members: :show-inheritance: @@ -13,7 +14,7 @@ lemur_cloudca Package -------------------- .. automodule:: lemur.plugins.lemur_cloudca.plugin + :noindex: :members: :undoc-members: :show-inheritance: - diff --git a/docs/developer/internals/lemur.plugins.lemur_email.rst b/docs/developer/internals/lemur.plugins.lemur_email.rst index 2dd704f8..e89fbfe8 100644 --- a/docs/developer/internals/lemur.plugins.lemur_email.rst +++ b/docs/developer/internals/lemur.plugins.lemur_email.rst @@ -5,6 +5,7 @@ lemur_email Package -------------------------- .. automodule:: lemur.plugins.lemur_email + :noindex: :members: :undoc-members: :show-inheritance: @@ -13,6 +14,7 @@ lemur_email Package -------------------- .. automodule:: lemur.plugins.lemur_email.plugin + :noindex: :members: :undoc-members: :show-inheritance: @@ -23,4 +25,3 @@ Subpackages .. toctree:: lemur.plugins.lemur_email.templates - diff --git a/docs/developer/internals/lemur.plugins.lemur_verisign.rst b/docs/developer/internals/lemur.plugins.lemur_verisign.rst index 1b2e5801..cc2bad84 100644 --- a/docs/developer/internals/lemur.plugins.lemur_verisign.rst +++ b/docs/developer/internals/lemur.plugins.lemur_verisign.rst @@ -5,6 +5,7 @@ lemur_verisign Package ----------------------------- .. automodule:: lemur.plugins.lemur_verisign + :noindex: :members: :undoc-members: :show-inheritance: @@ -13,6 +14,7 @@ lemur_verisign Package ----------------------- .. automodule:: lemur.plugins.lemur_verisign.constants + :noindex: :members: :undoc-members: :show-inheritance: @@ -21,7 +23,7 @@ lemur_verisign Package -------------------- .. automodule:: lemur.plugins.lemur_verisign.plugin + :noindex: :members: :undoc-members: :show-inheritance: - diff --git a/docs/developer/internals/lemur.roles.rst b/docs/developer/internals/lemur.roles.rst index 80777e52..8fa8b067 100644 --- a/docs/developer/internals/lemur.roles.rst +++ b/docs/developer/internals/lemur.roles.rst @@ -5,6 +5,7 @@ roles Package -------------------- .. automodule:: lemur.roles.models + :noindex: :members: :undoc-members: :show-inheritance: @@ -13,6 +14,7 @@ roles Package --------------------- .. automodule:: lemur.roles.service + :noindex: :members: :undoc-members: :show-inheritance: @@ -21,6 +23,7 @@ roles Package ------------------- .. automodule:: lemur.roles.views + :noindex: :members: :undoc-members: :show-inheritance: diff --git a/docs/developer/internals/lemur.status.rst b/docs/developer/internals/lemur.status.rst index cdd4e8cc..f28297d8 100644 --- a/docs/developer/internals/lemur.status.rst +++ b/docs/developer/internals/lemur.status.rst @@ -5,7 +5,7 @@ status Package ------------------- .. automodule:: lemur.status.views + :noindex: :members: :undoc-members: :show-inheritance: - diff --git a/docs/developer/internals/lemur.users.rst b/docs/developer/internals/lemur.users.rst index 9ce84ad3..e18306bf 100644 --- a/docs/developer/internals/lemur.users.rst +++ b/docs/developer/internals/lemur.users.rst @@ -5,6 +5,7 @@ users Package -------------------- .. automodule:: lemur.users.models + :noindex: :members: :undoc-members: :show-inheritance: @@ -13,6 +14,7 @@ users Package --------------------- .. automodule:: lemur.users.service + :noindex: :members: :undoc-members: :show-inheritance: @@ -21,7 +23,7 @@ users Package ------------------- .. automodule:: lemur.users.views + :noindex: :members: :undoc-members: :show-inheritance: - diff --git a/docs/developer/plugins/index.rst b/docs/developer/plugins/index.rst index 329a5a1b..ae07f1c2 100644 --- a/docs/developer/plugins/index.rst +++ b/docs/developer/plugins/index.rst @@ -75,6 +75,8 @@ at multiple plugins within your package:: That's it! Users will be able to install your plugin via ``pip install ``. +.. SeeAlso:: For more information about python packages see `Python Packaging `_ + .. _PluginInterfaces: Plugin Interfaces @@ -112,7 +114,7 @@ If you wish to be able to create new authorities implement the following functio .. Note:: - Lemur uses PEM (PKCS#7) certificates as it's internal standard, if you recieve certificates in other formats convert them to PEM before returning. + Lemur uses PEM formatted certificates as it's internal standard, if you receive certificates in other formats convert them to PEM before returning. If instead you do not need need to generate authorities but instead use a static authority (Verisign, DigiCert), you can use publicly available constants:: diff --git a/lemur/certificates/views.py b/lemur/certificates/views.py index eac23891..47511eaa 100644 --- a/lemur/certificates/views.py +++ b/lemur/certificates/views.py @@ -185,7 +185,7 @@ class CertificatesList(AuthenticatedResource): Host: example.com Accept: application/json, text/javascript - { + { "country": "US", "state": "CA", "location": "A Place", @@ -225,7 +225,7 @@ class CertificatesList(AuthenticatedResource): "commonName": "test", "validityStart": "2015-06-05T07:00:00.000Z", "validityEnd": "2015-06-16T07:00:00.000Z" - } + } **Example response**: