From dc198fec8ce1f81c5279f37171bd6df9bfa3e1f2 Mon Sep 17 00:00:00 2001 From: kevgliss Date: Fri, 3 Jun 2016 08:28:09 -0700 Subject: [PATCH] Docs (#344) * Adding release info. * adding some fields * Adding Source Plugin change. * Updating docs --- CHANGELOG.rst | 58 +++- README.rst | 8 - docs/administration.rst | 2 +- docs/developer/plugins/index.rst | 13 +- lemur/__about__.py | 2 +- lemur/authorities/views.py | 326 +++++++++++++------ lemur/certificates/views.py | 541 +++++++++++++++++++------------ lemur/destinations/views.py | 244 +++++++++----- lemur/domains/views.py | 6 +- lemur/notifications/views.py | 14 +- lemur/roles/schemas.py | 4 +- lemur/roles/views.py | 6 +- lemur/sources/views.py | 18 +- lemur/users/views.py | 2 +- 14 files changed, 809 insertions(+), 435 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index cb4f48d6..160e428a 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,12 +1,62 @@ Changelog ========= - -0.2.3 - `master` +0.3.1 - `master` ~~~~~~~~~~~~~~~~ .. note:: This version is not yet released and is under active development +0.3.0 - `master` +~~~~~~~~~~~~~~~~ + +This is quite a large upgrade, it is highly advised you backup your database before attempting to upgrade as this release +requires the migration of database structure as well as data. + + +Upgrading +--------- + +Please follow the `documentation `_ to upgrade Lemur. + + +Source Plugin Owners +-------------------- + +The dictionary returned from a source plugin has changed keys from `public_certificate` to `body` and `intermediate_certificate` to chain. + + +Issuer Plugin Owners +-------------------- + +This release may break your plugins, the keys in `issuer_options` have been changed from `camelCase` to `under_score`. +This change was made to break a undue reliance on downstream options maintains a more pythonic naming convention. Renaming +these keys should be fairly trivial, additionally pull requests have been submitted to affected plugins to help ease the transition. + +.. note:: This change only affects issuer plugins and does not affect any other types of plugins. + + +* Closed `#63 `_ - Validates all endpoints with Marshmallow schemas, this allows for + stricter input validation and better error messages when validation fails. +* Closed `#146 `_ - Moved authority type to first pane of authority creation wizard. +* Closed `#147 `_ - Added and refactored the relationship between authorities and their + root certificates. Displays the certificates (and chains) next the the authority in question. +* Closed `#199 `_ - Ensures that the dates submitted to Lemur during authority and + certificate creation are actually dates. +* Closed `#230 `_ - Migrated authority dropdown to a ui-select based dropdown, this + should be easier to determine what authorities are available and when an authority has actually been selected. +* Closed `#254 `_ - Forces certificate names to be generally unique. If a certificate name + (generated or otherwise) is found to be a duplicate we increment by appending a counter. +* Closed `#254 `_ - Switched to using Fernet generated passphrases for exported items. + These are more sounds that pseudo random passphrases generated before and have the nice property of being in base64. +* Closed `#278 `_ - Added ability to specify a custom name to certificate creation, previously + this was only available in the certificate import wizard. +* Closed `#281 `_ - Fixed an issue where notifications could not be removed from a certificate + via the UI. +* Closed `#289 `_ - Fixed and issue where intermediates were not being properly exported. +* Closed `#315 `_ - Made how roles are associated with certificates and authorities much more + explict, including adding the ability to add roles directly to certificates and authorities on creation. + + 0.2.2 - 2016-02-05 ~~~~~~~~~~~~~~~~~~ @@ -36,7 +86,7 @@ Changelog 0.2.0 - 2015-12-02 -~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~ * Closed #120 - Error messages not displaying long enough * Closed #121 - Certificate create form should not be valid until a Certificate Authority object is available @@ -52,7 +102,7 @@ Changelog 0.1.5 - 2015-10-26 -~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~ * **SECURITY ISSUE**: Switched from use a AES static key to Fernet encryption. Affects all versions prior to 0.1.5. If upgrading this will require a data migration. diff --git a/README.rst b/README.rst index fdeb3e9d..6e83ad73 100644 --- a/README.rst +++ b/README.rst @@ -5,10 +5,6 @@ Lemur :alt: Join the chat at https://gitter.im/Netflix/lemur :target: https://gitter.im/Netflix/lemur?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge -.. image:: https://img.shields.io/pypi/v/lemur.svg - :target: https://pypi.python.org/pypi/lemur/ - :alt: Latest Version - .. image:: https://readthedocs.org/projects/lemur/badge/?version=latest :target: https://lemur.readthedocs.org :alt: Latest Docs @@ -20,10 +16,6 @@ Lemur :target: https://requires.io/github/Netflix/lemur/requirements/?branch=master :alt: Requirements Status -.. image:: https://badge.waffle.io/Netflix/lemur.png?label=ready&title=Ready - :target: https://waffle.io/Netflix/lemur - :alt: 'Stories in Ready' - Lemur manages TLS certificate creation. While not able to issue certificates itself, Lemur acts as a broker between CAs and environments providing a central portal for developers to issue TLS certificates with 'sane' defaults. diff --git a/docs/administration.rst b/docs/administration.rst index 5884eef5..6f70bd5e 100644 --- a/docs/administration.rst +++ b/docs/administration.rst @@ -273,7 +273,7 @@ For more information about how to use social logins, see: `Satellizer