airship
/
deckhand
Code Issues Proposed changes

Add docs-on-readthedocs to .zuul.yaml templates 

This patchset adds docs-on-readthedocs openstack-infra template
to Deckhand's .zuul.yaml templates and makes some documentation
changes to test the template.

.. https://github.com/openstack-infra/zuul-jobs/blob/master/playbooks/python/readthedocs.yaml

Change-Id: I000fc1e3be9dd4cf333fa28d7739747eb9003adc
This commit is contained in:
Felipe Monteiro 2018-06-04 15:37:42 -04:00
parent bf4d567a57
commit fa0e26938b
2 changed files with 65 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.zuul.yaml
View File

@ -11,6 +11,8 @@
# limitations under the License. # limitations under the License.
- project: - project:
templates:
- docs-on-readthedocs
check: check:
jobs: jobs:
- airship-deckhand-tox-py27-postgresql - airship-deckhand-tox-py27-postgresql

64
doc/source/document-types.rst
View File

@ -23,7 +23,7 @@ Control Documents
----------------- -----------------
Control documents (documents which have ``metadata.schema=metadata/Control/v1``), Control documents (documents which have ``metadata.schema=metadata/Control/v1``),
are special, and are used to control the behavior of Deckhand at runtime. Only are special, and are used to control the behavior of Deckhand at runtime. Only
the following types of control documents are allowed. the following types of control documents are allowed.
DataSchema DataSchema
@ -143,6 +143,40 @@ Certificate
-----END CERTIFICATE----- -----END CERTIFICATE-----
... ...
CertificateAuthority
^^^^^^^^^^^^^^^^^^^^
.. code-block:: yaml
---
schema: deckhand/CertificateAuthority/v1
metadata:
schema: metadata/Document/v1
name: application-ca
storagePolicy: cleartext
data: some-ca
...
CertificateAuthorityKey
^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: yaml
---
schema: deckhand/CertificateAuthorityKey/v1
metadata:
schema: metadata/Document/v1
name: application-ca-key
storagePolicy: encrypted
data: |-
-----BEGIN CERTIFICATE-----
MIIDYDCCAkigAwIBAgIUKG41PW4VtiphzASAMY4/3hL8OtAwDQYJKoZIhvcNAQEL
...snip...
P3WT9CfFARnsw2nKjnglQcwKkKLYip0WY2wh3FE7nrQZP6xKNaSRlh6p2pCGwwwH
HkvVwA==
-----END CERTIFICATE-----
...
CertificateKey CertificateKey
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
@ -175,3 +209,31 @@ Passphrase
storagePolicy: encrypted storagePolicy: encrypted
data: some-password data: some-password
... ...
PrivateKey
^^^^^^^^^^
.. code-block:: yaml
---
schema: deckhand/PrivateKey/v1
metadata:
schema: metadata/Document/v1
name: application-private-key
storagePolicy: encrypted
data: some-private-key
...
PublicKey
^^^^^^^^^
.. code-block:: yaml
---
schema: deckhand/PublicKey/v1
metadata:
schema: metadata/Document/v1
name: application-public-key
storagePolicy: cleartext
data: some-password
...