Felipe Monteiro 9d1e27f040 Treat warnings as errors in docs and fix warnings

This patch set fixes Promenade's failing documenation job (it
is currently issuing a number of warnings that should be treated
as errors):

/home/zuul/src/git.openstack.org/openstack/airship-promenade/doc/source/configuration/index.rst:10: WARNING: toctree contains reference to nonexisting document 'configuration/encryption-policy'
WARNING: autodoc: failed to import exception 'exceptions.ApiError' from module 'promenade'; the following exception was raised:
No module named 'falcon'

The first one indicates that the file has the wrong extension
and the second one that autodoc is failing to import something
(first case => rename file, second case => add requirement to
test-requirements.txt)

.. http://logs.openstack.org/18/605818/1/gate/airship-promenade-unit-py35/c733138/ara-report/

Change-Id: I974d5929aaac8a6e27d4196eed5f8bc97703e61d

2018-10-04 14:25:22 +00:00

766 B

Raw Blame History

EncryptionPolicy

Encryption policy defines how encryption should be applied via Promenade. The primary use-case for this is to encrypt genesis.sh or join.sh scripts.

Sample Document

---
schema: promenade/EncryptionPolicy/v1
metadata:
  schema: metadata/Document/v1
  name: encryption-policy
  layeringDefinition:
    abstract: false
    layer: site
  storagePolicy: cleartext
data:
  scripts:
    genesis:
      gpg: {}
...

Scripts

The genesis and join scripts can be built with sensitive content encrypted. Currently the only encryption method available is gpg, which can be enabled by setting that key to an empty dictionary.

766 B Raw Blame History

EncryptionPolicy

Sample Document

Scripts

766 B

Raw Blame History