A configuration organization tool.
Go to file
Drew Walters 38fd699992 Update Airship vulnerability link
The Airship vulnerability documentation has moved [0]. This change
updates SECURITY.md to point to the correct location.

[0] https://docs.airshipit.org/learn/vulnerabilities.html

Change-Id: Iea843a3399bc7836f5645c3ca81603e2e9ca7356
Signed-off-by: Drew Walters <andrew.walters@att.com>
2020-06-10 15:54:42 +00:00
.github Update Airship vulnerability link 2020-06-10 15:54:42 +00:00
doc Return -o (--output*) option back as deprecated. 2020-01-28 19:53:53 -06:00
images/pegleg Bionic pegleg airship clients 2020-03-13 15:12:52 +00:00
pegleg Fail early on invalid save locations 2020-05-04 12:35:53 -04:00
releasenotes Move generate-pki under generate sub-command 2019-11-20 19:16:12 +00:00
site_yamls/site CLI capability to generate and encrypt passphrases 2019-01-29 16:24:31 -06:00
tests Update Treasuremap ref to use valid certs 2020-05-21 12:33:47 -04:00
tools Bionic pegleg airship clients 2020-03-13 15:12:52 +00:00
.dockerignore Update to UCP layout standard 2018-03-05 07:42:00 -06:00
.gitignore Add deployment_data to rendered docs 2019-09-17 12:39:33 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:52:19 +00:00
.readthedocs.yaml Fix: Pegleg Exceptions docs rendering on RTD 2019-07-12 16:48:43 +02:00
.style.yapf Standardize Pegleg code with YAPF 2019-07-25 17:28:18 +00:00
.zuul.yaml Disable voting on OpenSUSE gates 2019-12-17 11:09:10 -06:00
LICENSE Initial commit 2018-01-26 15:47:15 -06:00
Makefile Resolves installation problems in Docker 2019-08-16 12:24:57 -05:00
Pipfile Uplift Promenade version in Pegleg requirements 2020-06-10 12:46:22 +00:00
Pipfile.lock Uplift Promenade version in Pegleg requirements 2020-06-10 12:46:22 +00:00
README.rst Typo fix: getting started URL 2019-01-23 09:35:27 +01:00
requirements.txt Uplift Promenade version in Pegleg requirements 2020-06-10 12:46:22 +00:00
setup.py Refactors pegleg CLI to use single commands 2019-12-17 19:32:28 +00:00
tox.ini Revert tox to Xenial supported version 2019-08-16 10:53:30 -05:00
vcs-requirements.env Uplift Promenade version in Pegleg requirements 2020-06-10 12:46:22 +00: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.