Phil Sphicas 417975b596 Uniquely name managed documents
When pegleg wraps documents, it uses the original document name as the
name of the managed document. This often results in duplicate documents
(i.e. identical in name and schema). For example, it is expected to have
identically named deckhand document pairs: Certificate & CertificateKey;
CertificateAuthority & CertificateAuthorityKey; PublicKey & PrivateKey.

However, this could also occur for unrelated document types that happen
to have the same name, and generally defeats the principle that each
document is identified by a schema top-level key and the metadata.name.

This change uses a combination of the original document schema and name
to build the name of the pegleg/PeglegManagedDocument/v1.

Change-Id: Iab186ae7e9d24a30cb413be89a17fad960e10bea
2020-04-20 18:45:55 +00:00
2020-02-20 17:14:52 -06:00
2020-04-20 18:45:55 +00:00
2020-04-20 18:45:55 +00:00
2020-03-13 15:12:52 +00:00
2018-03-05 07:42:00 -06:00
2019-04-19 19:52:19 +00:00
2019-07-25 17:28:18 +00:00
2019-12-17 11:09:10 -06:00
2018-01-26 15:47:15 -06:00
2020-03-13 15:12:52 +00:00
2020-03-13 15:12:52 +00:00
2019-01-23 09:35:27 +01:00
2020-03-13 15:12:52 +00:00
2019-08-16 10:53:30 -05:00
2020-01-28 15:13:40 -06:00

Pegleg

Docker Repository on Quay Doc Status

Introduction

Pegleg is a document aggregator that provides early linting and validations via Deckhand, a document management micro-service within Airship.

Pegleg supports local and remote Git repositories. Remote repositories can be cloned using a variety of protocols -- HTTP(S) or SSH. Afterward, specific revisions within those repositories can be checked out, their documents aggregated, linted, and passed to the rest of Airship for orchestration, allowing document authors to manage their site definitions using version control.

Find more documentation for Pegleg on Read the Docs.

Core Responsibilities

  • aggregation - Aggregates all documents required for site deployment across multiple Git repositories, each of which can be used to maintain separate document sets in isolation
  • linting - Configurable linting checks documents for common syntactical and semantical mistakes

Getting Started

For more detailed installation and setup information, please refer to the Getting Started guide.

Integration Points

Pegleg has the following integration points:

  • Deckhand which provides document revision management, storage and rendering functionality upon which the rest of the Airship components rely for orchestration of infrastructure provisioning.

Further Reading

Airship.

Description
A configuration organization tool.
Readme 10 MiB
Languages
Python 98.4%
Makefile 0.8%
Shell 0.8%