From afb66df1a4f9c07e29e8756e6805991aa915c156 Mon Sep 17 00:00:00 2001 From: kevgliss Date: Wed, 29 Jun 2016 10:08:54 -0700 Subject: [PATCH] Adding plugin information to docs. (#379) * Adding documentation about the installed plugins. * Adding new default option. --- docs/administration.rst | 155 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 149 insertions(+), 6 deletions(-) diff --git a/docs/administration.rst b/docs/administration.rst index 6f70bd5e..ddecdaff 100644 --- a/docs/administration.rst +++ b/docs/administration.rst @@ -151,6 +151,14 @@ and are used when Lemur creates the CSR for your certificates. LEMUR_DEFAULT_ORGANIZATIONAL_UNIT = "Operations" +.. data:: LEMUR_DEFAULT_ISSUER_PLUGIN + :noindex: + + :: + + LEMUR_DEFAULT_ISSUER_PLUGIN = "verisign-issuer" + + Notification Options -------------------- @@ -682,15 +690,150 @@ Plugins There are several interfaces currently available to extend Lemur. These are a work in progress and the API is not frozen. -Bundled Plugins ---------------- +Lemur includes several plugins by default. Including extensive support for AWS, VeriSign/Symantec. -Lemur includes several plugins by default. Including extensive support for AWS, VeriSign/Symantec and CloudCA services. +Verisign/Symantec +----------------- -3rd Party Extensions --------------------- +:Authors: + Kevin Glisson +:Type: + Issuer +:Description: + Basic support for the VICE 2.0 API + + +Cryptography +------------ + +:Authors: + Kevin Glisson , + Mikhail Khodorovskiy +:Type: + Issuer +:Description: + Toy certificate authority that creates self-signed certificate authorities. + Allows for the creation of arbitrary authorities and end-entity certificates. + This is *not* recommended for production use. + + +Acme +---- + +:Authors: + Kevin Glisson , + Mikhail Khodorovskiy +:Type: + Issuer +:Description: + Adds support for the ACME protocol (including LetsEncrypt) with domain validation being handled Route53. + + +Atlas +----- + +:Authors: + Kevin Glisson +:Type: + Metric +:Description: + Adds basic support for the `Atlas `_ telemetry system. + + +Email +----- + +:Authors: + Kevin Glisson +:Type: + Notification +:Description: + Adds support for basic email notifications via SES. + + +Slack +----- + +:Authors: + Harm Weites +:Type: + Notification +:Description: + Adds support for slack notifications. + + +AWS +---- + +:Authors: + Kevin Glisson +:Type: + Source +:Description: + Uses AWS IAM as a source of certificates to manage. Supports a multi-account deployment. + + +AWS +---- + +:Authors: + Kevin Glisson +:Type: + Destination +:Description: + Uses AWS IAM as a destination for Lemur generated certificates. Support a multi-account deployment. + + +Kubernetes +---------- + +:Authors: + Mikhail Khodorovskiy +:Type: + Destination +:Description: + Allows Lemur to upload generated certificates to the Kubernetes certificate store. + + +Java +---- + +:Authors: + Kevin Glisson +:Type: + Export +:Description: + Generates java compatible .jks keystores and truststores from Lemur managed certificates. + + +Openssl +------- + +:Authors: + Kevin Glisson +:Type: + Export +:Description: + Leverages Openssl to support additional export formats (pkcs12) + + +3rd Party Plugins +================= + +The following plugins are available and maintained by members of the Lemur community: + +Digicert +-------- + +:Authors: + Chris Dorros +:Type: + Issuer +:Description: + Adds support for basic Digicert +:Links: + https://github.com/opendns/lemur-digicert -The following extensions are available and maintained by members of the Lemur community: Have an extension that should be listed here? Submit a `pull request `_ and we'll get it added.