Infra
/
lemur
5
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Spell fixes in docs (#740)

This commit is contained in:
Brint O'Hearn 2017-03-30 23:09:30 -05:00 committed by kevgliss
parent f91ae5b319
commit e18a188723
3 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/developer/index.rst
View File

@ -86,7 +86,7 @@ You'll likely want to make some changes to the default configuration (we recomme
lemur upgrade lemur upgrade
.. note:: The ``upgrade`` shortcut is simply a shorcut to Alembic's upgrade command. .. note:: The ``upgrade`` shortcut is simply a shortcut to Alembic's upgrade command.
Coding Standards Coding Standards
@ -285,4 +285,3 @@ Internals
:maxdepth: 2 :maxdepth: 2
internals/lemur internals/lemur

6
docs/developer/plugins/index.rst
View File

@ -180,7 +180,7 @@ The schema for defining plugin options are pretty straightforward:
- **Type** there are currently four supported variable types - **Type** there are currently four supported variable types
- **Int** creates an html integer box for the user to enter integers into - **Int** creates an html integer box for the user to enter integers into
- **Str** creates a html text input box - **Str** creates a html text input box
- **Boolean** creates a checkbox for the user to signify truithyness - **Boolean** creates a checkbox for the user to signify truthiness
- **Select** creates a select box that gives the user a list of options - **Select** creates a select box that gives the user a list of options
- When used a `available` key must be provided with a list of selectable options - When used a `available` key must be provided with a list of selectable options
- **Required** determines if this option is required, this **must be a boolean value** - **Required** determines if this option is required, this **must be a boolean value**
@ -196,7 +196,7 @@ Notification
------------ ------------
Lemur includes the ability to create Email notifications by **default**. These notifications Lemur includes the ability to create Email notifications by **default**. These notifications
currently come in the form of expiration noticies. Lemur periodically checks certifications expiration dates and currently come in the form of expiration notices. Lemur periodically checks certifications expiration dates and
determines if a given certificate is eligible for notification. There are currently only two parameters used to determines if a given certificate is eligible for notification. There are currently only two parameters used to
determine if a certificate is eligible; validity expiration (date the certificate is no longer valid) and the number determine if a certificate is eligible; validity expiration (date the certificate is no longer valid) and the number
of days the current date (UTC) is from that expiration date. of days the current date (UTC) is from that expiration date.
@ -207,7 +207,7 @@ are trying to create a new notification type (audit, failed logins, etc.) this w
You would also then need to build additional code to trigger the new notification type. You would also then need to build additional code to trigger the new notification type.
The second is `ExpirationNotificationPlugin`, this object inherits from `NotificationPlugin` object. The second is `ExpirationNotificationPlugin`, this object inherits from `NotificationPlugin` object.
You will most likely want to base your plugin on, if you want to add new channels for expiration notices (Slack, Hipcat, Jira, etc.). It adds default options that are required by You will most likely want to base your plugin on, if you want to add new channels for expiration notices (Slack, HipChat, Jira, etc.). It adds default options that are required by
all expiration notifications (interval, unit). This interface expects for the child to define the following function:: all expiration notifications (interval, unit). This interface expects for the child to define the following function::
def send(self, notification_type, message, targets, options, **kwargs): def send(self, notification_type, message, targets, options, **kwargs):

4
docs/production/index.rst
View File

@ -50,7 +50,7 @@ The amount of effort you wish to expend ensuring that Lemur has good entropy to
If you wish to generate more entropy for your system we would suggest you take a look at the following resources: If you wish to generate more entropy for your system we would suggest you take a look at the following resources:
- `WES-entropy-client <https://github.com/WhitewoodCrypto/WES-entropy-client>`_ - `WES-entropy-client <https://github.com/WhitewoodCrypto/WES-entropy-client>`_
- `haveaged <http://www.issihosts.com/haveged/>`_ - `haveged <http://www.issihosts.com/haveged/>`_
For additional information about OpenSSL entropy issues: For additional information about OpenSSL entropy issues:
@ -316,4 +316,4 @@ Example cron entries::
0 22 * * * lemuruser export LEMUR_CONF=/Users/me/.lemur/lemur.conf.py; /www/lemur/bin/lemur notify 0 22 * * * lemuruser export LEMUR_CONF=/Users/me/.lemur/lemur.conf.py; /www/lemur/bin/lemur notify
*/15 * * * * lemuruser export LEMUR_CONF=/Users/me/.lemur/lemur.conf.py; /www/lemur/bin/lemur sync -s all */15 * * * * lemuruser export LEMUR_CONF=/Users/me/.lemur/lemur.conf.py; /www/lemur/bin/lemur sync -s all
0 22 * * * lemuruser export LEMUR_CONF=/Users/me/.lemur/lemur.conf.py; /www/lemur/bin/lemur check_revoked 0 22 * * * lemuruser export LEMUR_CONF=/Users/me/.lemur/lemur.conf.py; /www/lemur/bin/lemur check_revoked