diff --git a/README.rst b/README.rst index 55e5a5d6..b1ceca3e 100644 --- a/README.rst +++ b/README.rst @@ -77,7 +77,8 @@ unit tests, run: for example. -To run unit tests using postgresql, execute: +To run unit tests using postgresql, postgresql must be installed in your +environment. Then execute: :: @@ -96,16 +97,28 @@ You can also run a subset of tests via a regex: $ tox -e functional -- gabbi.suitemaker.test_gabbi_document-crud-success-multi-bucket -Manual Testing -^^^^^^^^^^^^^^ -Document creation can be tested locally using (from root deckhand directory): +Intgration Points +================= -.. code-block:: console +Deckhand has the following integration points: - $ curl -i -X PUT localhost:9000/api/v1.0/bucket/{bucket_name}/documents \ - -H "Content-Type: application/x-yaml" \ - --data-binary "@deckhand/tests/unit/resources/sample_document.yaml" + * `Keystone (OpenStack Identity service) `_ + provides authentication and support for role based authorization. + * `PostgreSQL `_ is used to persist information + to correlate workflows with users and history of workflow commands. - # revision_id copy/pasted from previous response. - $ curl -i -X GET localhost:9000/api/v1.0/revisions/1 +Though, being a low-level service, has many other UCP services that integrate +with it, including: + + * `Drydock `_ is orchestrated by + Shipyard to perform bare metal node provisioning. + * `Promenade `_ is indirectly + orchestrated by Shipyard to configure and join Kubernetes nodes. + * `Armada `_ is orchestrated by + Shipyard to deploy and test Kubernetes workloads. + +Further Reading +=============== + +`Undercloud Platform (UCP) `_. diff --git a/doc/source/testing.rst b/doc/source/testing.rst index 29991d66..770b2896 100644 --- a/doc/source/testing.rst +++ b/doc/source/testing.rst @@ -40,7 +40,8 @@ unit tests, run:: for example. -To run unit tests using postgresql, execute:: +To run unit tests using postgresql, postgresql must be installed in your +environment. Then execute:: $ tox -epy27-postgresql $ tox -epy35-postgresql