Commit Graph

22 Commits

Author SHA1 Message Date
Scott Hussey 7c90da14b4 docs: Add doc building jobs and doc index page with link
* Rename docs => doc for OpenStack convention compliance
* Add tox.ini job for docs building (no setup.py required)
* Add Makefile with docs entrypoint
* Add a link to the airship-specs subproject.

Change-Id: I835633405b3dac671aa123eb4ee04645f390c352
2018-08-06 21:41:39 -05:00
Bryan Strassner 2f33e6c4b4 Remove the blueprintsi from airship-in-a-bottle
Airship-specs is the new home for this sort of thing.

Change-Id: I9ef6b4c8892f215044e77af5a3dde18380d56e95
2018-08-01 13:21:43 -05:00
Zuul 3fcdf434fc Merge "Promenade: Update git refs to OpenStack-Infra" 2018-06-06 16:33:41 +00:00
Zuul 3b306e5fea Merge "Drydock: Update git refs to OpenStack-Infra" 2018-06-06 16:33:40 +00:00
Pete Birley e3f95d332a OSH: Update git refs to OpenStack-Infra
This PS updates the git refs to use OpenStack's git, rather than the
github mirrors for OSH components.

Change-Id: Ibc9ea52ccd3505eaf7da932cdfc1c29212b3c535
Signed-off-by: Pete Birley <pete@port.direct>
2018-06-06 01:49:06 +00:00
Pete Birley 68e857967f Promenade: Update git refs to OpenStack-Infra
This PS updates the git refs to use OpenStack's git, rather than att-comdev
for Airship components.

Change-Id: I39758de6424f5de22513dd33e60c326637ac22e1
Signed-off-by: Pete Birley <pete@port.direct>
2018-06-05 04:13:44 +00:00
Pete Birley be3e0fedde Drydock: Update git refs to OpenStack-Infra
This PS updates the git refs to use OpenStack's git, rather than att-comdev
for Airship components.

Change-Id: I981bb57b3e8981d17c963658a14532d02916c061
Signed-off-by: Pete Birley <pete@port.direct>
2018-06-05 04:13:17 +00:00
Zuul d91a12d652 Merge "Airship documentation placeholder for construction" 2018-05-30 19:28:38 +00:00
Bryan Strassner b6577eb86c Add beginning of Developer documentation
Adds a survey of commonly used components and platform items
that a developer will want to have familiarity while developing
in Airship.

Change-Id: I5a5f28a873481adee13e7b899d3815747ee97895
2018-05-29 14:22:39 -05:00
Bryan Strassner b0d37610e0 Airship documentation placeholder for construction
Updates the index of the airship-in-a-bottle documentation to
include disclaimer about pending major changes to the
documentation.

Change-Id: Ia87ca146060d13d5b28693539b8f31d78ad4cfd0
2018-05-24 16:30:26 -05:00
Bryan Strassner f81a666d5e Update UCP code standards to include make target for tests
Change-Id: Idc7294e0caf28eb7d58074296fce773ad9817971
2018-05-03 11:55:45 -05:00
Bryan Strassner ca006cc586 Design for deployment strategy
Define the changes and work necessary for deployment strategy such
that baremetal nodes can be deployed in chunks, and be driven by
success conditions.

Change-Id: Ic0b6f93d5748060e747119ad860143fdfd5d0682
2018-04-17 17:26:32 -04:00
Bryan Strassner 3e76d16f74 UCP node teardown design
Provides design for the changes to support node teardown in UCP

Change-Id: I8a90e0afac2ba3b469cc8f1c135f017a9cf199b6
2018-02-12 16:56:08 -06:00
Bryan Strassner 7f2da755c2 Add diagnostic field info for ValidationMessage
Change-Id: Id7a936b9d8cfaacf2b878f0c8bec128fcc998fce
2018-01-27 18:23:52 -06:00
Bryan Strassner 3d2a9a1d87 Specifies ValidationMessage for validation responses
The need for expanded information as a result of validations run
by UCP necessitate a more specific validation messge response type.
This change introduces a backwards-compatible path for applications
to move to better validation reponses.

Change-Id: If7c70e29da87c6279128854f1b1a7465e831d746
2018-01-23 10:19:30 -04:00
Bryan Strassner c51d75705d Provide for UCP standards and conventions
This change intends to account for various standards and conventions
used by the undercloud components. As the topic of conventions for
any active project is naturally open ended, this set of changes does
not intend to be a complete representation.

Several of the sections identified for conventions are marked as under
development, and will not be formalized as part of this change.

Change-Id: Ideaa9ed4146f4a6dcd2d3c44037bcac2ed3755bb
2018-01-02 14:48:51 -06:00
Bryan Strassner 977cd8c3bb Documentation Fix
Update deckhand design-reference format to reflect better the url
used by shipyard to represent the revisions endpoint.

Minor reformatting for line length

Change-Id: I629d0d755266baf56178e8bb342c22eeb4cdbcab
2017-10-15 17:01:51 -05:00
Felipe Monteiro 0c1207a51c Versions API UCP requirement
This PS adds a new UCP requirement for each UCP component to
return a list of its API versions via GET /versions.

Change-Id: Id448abab386df1fec3f1008182d94b9cdd6923a8
2017-09-26 12:27:41 -04:00
Scott Hussey 2128967be1 Generalize error response
Generalize the specified error response standard to be usable
for status responses of all kinds including detailed responses
describing actions taken to successfully satisfy a request.

Change-Id: I51970ce53c92d67d786efac226dfa62a40d0bcee
2017-09-20 13:07:44 -05:00
Anthony Lin e66a6507ad UCP Component Health Check API Endpoint
As discussed, each UCP component will return a simple
response using HTTP Codes to indicate that it is alive

Enhancements to the health check endpoint will be made
at a later stage

Change-Id: I52eb333191fc148d2ea543632c798a3c087347d8
2017-09-01 23:08:16 +00:00
Bryan Strassner 383dcaeb4e Update the ucp api docs to include information about validations
Updated the error response for more clarity.

Change-Id: I0c5f57ecf2d68c3c57a1423426d2e9cf190044cc
2017-08-29 14:08:25 -05:00
Bryan Strassner 3a48396699 Add first attempt at UCP API conventions for review
Add convention for standard headers supported by UCP components

Incorporated feedback from Filipe and Scott

Fix spelling of client from cleint

Change-Id: I78be3e604d3abdca04ad0f6aefc468afe420c912
2017-08-08 13:38:40 -05:00