15 Commits

Author SHA1 Message Date
Felipe Monteiro
6b56f1d1ab Update README to correct typos and deprecated, misleading sections
This PS simply updates the README to correct typos (intgration =>
integration) and reword misleading sections, as well as update
deprecated sections. Finally, new sections related to Barbican
have been added.

Change-Id: I92611cf2aecf5ee1295ba9014002cd0e18f3a6af
2018-04-30 18:42:58 +00:00
Felipe Monteiro
a691f9a47f Add readthedocs link to Deckhand readme
Change-Id: Id3aeccec0730fe0556446d42facfd222751d636c
2018-03-16 12:41:20 -04:00
Felipe Monteiro
3c8a65a813 Docs: Update README and create Getting Started docs
Update the README by moving a lot of the manual installation into
Getting Started docs and simplify some of the documentation because
Deckhand can be re-run using sqlite (for dev purposes, for example).

Change-Id: I5742dc75b95e2af67a18b419d04e769c10a1e43e
2018-02-21 15:26:22 -05:00
Felipe Monteiro
b96391dbbc Update Deckhand README
Part of the README is out of date and needs to be updated. The
Getting Started section was also updated to contain information
about how to run Deckhand via Docker as well as how to do a
complete manual install of Deckhand.

The testing documentation was also updated because some tox
jobs have been removed, so the commands in the README should too.

Change-Id: I4438d3b3462e06923969831242cb377237c03480
2018-02-02 10:59:53 -05:00
Felipe Monteiro
10dd211ade Docs: Include a high-level overview of Deckhand functionality
Change-Id: I40cb5efcff04393b28a8463bcc17ae8de243b466
2018-01-14 22:40:41 -05:00
Mark Burnett
69db7f81fa Test: add unusual documents to functional testing
Unusual documents are documents with different data
types for the data field. The data types include:
object, array, string and integer.

This PS makes necessary ORM model and schema
changes needed to support the different data types.

The ORM data type for the data column has been changed
to JSONB for PostgreSQL. Thus, DH now only supports
PostgreSQL. As a result, the tox jobs have been updated
to only use postgre.

Change-Id: I53694d56bef71adacb5eb79162678be73acb4ad8
2018-01-10 23:33:01 -04:00
Felipe Monteiro
1d3fce4674 Update Deckhand README and testing documentation
Change-Id: I05052793589e46cc0ee0a2f489ff1d61ca20fc1b
2017-10-26 09:52:38 -04:00
Felipe Monteiro
cdec6356a5 Add health resource for ucp-integration API convention
It is a UCP API convention to include a health resource in order
for other components to access and validate Deckhand's health status [0].

As such, this PS accomplishes that goal. Also add uwsgi.ini file to
instantiate the webserver using a more complex configuration that
can be overriden more easily.

[0] https://github.com/att-comdev/ucp-integration/blob/master/docs/api-conventions.md#health-check-api

Change-Id: Ice24cec6d0b98c16af62d9436925083d4092a032
2017-10-23 17:34:03 +01:00
Felipe Monteiro
c69f29e92f Revamp Deckhand documentation
This PS updates all Deckhand documentation to be
sphinx-compliant so that it can be rendered into
HTML automatically for hosting.

This PS also removes deprecated/redundant/unhelpful
documentation and upates README to a bit more
informative and helpful. The design.md file has been
broken up into different sections with deckhand/docs
for easier consumption.

Change-Id: I44afcd22a7f5f05e44563342bb98b30fd806f598
2017-10-16 20:11:56 +01:00
Felipe Monteiro
e1446bb9e1 [feat] DECKHAND-28: Document pre-validation logic and API integration
This commit constitutes 1 of 2 monolithic ports from Github.
The following major changes have been made:

  - Created schemas for validating different types of documents
    (control and document schemas), including:
    * certificate key
    * certificate
    * data schema
    * document
    * layering policy
    * passphrase
    * validation policy
  - Implemented pre-validation logic which validates that each
    type of document conforms to the correct schema specifications
  - Implemented views for APIs -- this allows views to change the
    DB data to conform with API specifications
  - Implemented relevant unit tests
  - Implement functional testing foundation

Change-Id: I83582cc26ffef91fbe95d2f5f437f82d6fef6aa9
2017-08-08 18:52:44 +01:00
Felipe Monteiro
bbd0292455 Remove oslo_versionedobjects
This commit also updates documentation for launching test app.
2017-07-21 04:22:59 +01:00
Felipe Monteiro
22343071d8 Update README 2017-07-17 21:55:40 +01:00
Felipe Monteiro
6a25e6f06b Add oslo.log integration
This commit adds oslo.log integration to Deckhand.
2017-07-06 23:45:09 +01:00
Felipe Monteiro
00bb92561d DECKHAND-2: Design core Deckhand API framework
This commit implements the core Deckhand API framework.
It does not implement any real API routes. The core
framework is modeled after Drydock's [0].

This commit specifically:

  - implements the core API framework which uses falcon
  - implements errors.py for preliminary errors
  - implements base resource class from which other API
    resources will inherit to build out the API itself
  - implements base API router
  - implements entry-point for kicking off deckhand
  - updates base README.rst with instructions on
  - running and installing -- similar to Drydock's
  - implements dummy API resource for secrets, to
    be fleshed out further in a follow-up commit

[0] https://github.com/att-comdev/drydock
2017-06-27 19:26:51 +01:00
Felipe Monteiro
eab524abd8 Oslo config integration (#1)
* DECKHAND-11: Add oslo.config integration to Deckhand

This commit adds oslo.config integration to Deckhand. It also
creates a lot of preliminary files/configuration settings
needed to run tox as well as lint and oslo-config-generator
jobs.

* Remove sample config file.
2017-06-26 16:57:50 -07:00