When performing substitutions, there are occasions when the source value does not exactly match the format required by the destination document (e.g. the values.yaml structure of an Armada chart). This change provides the ability extract a substring of the source value, and substitute that into the destination document. Two optional fields are added to `src` under `metadata.substitutions`: * `pattern`: a regular expression, with optional capture groups * `match_group`: the number of the desired capture group The canonical use case is a chart that requires an image with the repo name and tag in separate fields, while the substitution source has the full image path as a single value. For example, assuming that the source document "software-versions" has: data: images: hello: docker.io/library/hello-world:latest Then the following set of substitutions would put the repo and tag in the applicable values in the destination document: metadata: substitutions: - src: schema: pegleg/SoftwareVersions/v1 name: software-versions path: .images.hello pattern: '^(.*):(.*)' match_group: 1 dest: path: .values.images.hello.repo - src: schema: pegleg/SoftwareVersions/v1 name: software-versions path: .images.hello pattern: '^(.*):(.*)' match_group: 2 dest: path: .values.images.hello.tag data: values: images: hello: repo: # docker.io/library/hello-world tag: # latest Change-Id: I2fcb0d2b8e2fe3d85479ac2bad0b7b90f434eb77
|4 months ago|
|.github||2 years ago|
|alembic||2 years ago|
|charts/deckhand||8 months ago|
|deckhand||4 months ago|
|doc||4 months ago|
|etc/deckhand||4 years ago|
|images/deckhand||9 months ago|
|releasenotes||4 years ago|
|tools||7 months ago|
|.coveragerc||5 years ago|
|.dockerignore||4 years ago|
|.gitignore||4 years ago|
|.gitreview||3 years ago|
|.stestr.conf||4 years ago|
|.zuul.yaml||4 months ago|
|HACKING.rst||4 years ago|
|LICENSE||4 years ago|
|Makefile||2 years ago|
|README.rst||4 years ago|
|REVIEWING.rst||4 years ago|
|alembic.ini||4 years ago|
|bindep.txt||3 years ago|
|entrypoint.sh||2 years ago|
|requirements.txt||9 months ago|
|setup.cfg||3 years ago|
|setup.py||5 years ago|
|test-requirements.txt||1 year ago|
|tox.ini||7 months ago|
Deckhand provides document revision management, storage and mutation functionality upon which the rest of the Airship components rely for orchestration of infrastructure provisioning. Deckhand understands declarative YAML documents that define, end-to-end, the configuration of sites: from the hardware -- encompassing network topology and hardware and host profile information -- up to the software level that comprises the overcloud.
- Free software: Apache license
- Documentation: https://airship-deckhand.readthedocs.io/en/latest/
- Source: https://git.openstack.org/cgit/openstack/airship-deckhand
- Bugs: https://storyboard.openstack.org/#!/project/1004
- Release notes: https://airship-deckhand.readthedocs.io/en/latest/releasenotes/index.html
- layering - helps reduce duplication in configuration by applying the notion of inheritance to documents
- substitution - provides separation between secret data and other configuration data for security purposes and reduces data duplication by allowing common data to be defined once and substituted elsewhere dynamically
- revision history - maintains well-defined collections of documents within immutable revisions that are meant to operate together, while providing the ability to rollback to previous revisions
- validation - allows services to implement and register different kinds of validations and report errors
- secret management - leverages existing OpenStack APIs -- namely Barbican -- to reliably and securely store sensitive data
For more detailed installation and setup information, please refer to the Getting Started guide.
Deckhand has the following integration points:
- Barbican (OpenStack Key Manager) provides secure storage for sensitive data.
- 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.
Currently, other database back-ends are not supported.
Though, being a low-level service, has many other Airship services that integrate with it, including: