A configuration organization tool.

Go to file

Alexander Hughes 766e53dfb4 Update safety check for Python dependencies This patch: 1. Updates the `tox -e safety` command to run the Safety tool [0] against both the Pegleg requirements.txt and the doc/requirements.txt file used only when `tox -e docs` is run. 2. Updates doc/requirements.txt with pinned dependencies so that Safety can check those dependencies. At the time of this patch it is expected for the non-voting Safety gate to fail, because the Promenade version used by Pegleg requires an insecure version of kubernetes, 3.0.0. This version of Kubernetes is impacted by [1] due to the urllib version being used. [0] https://pypi.org/project/safety/ [1] https://nvd.nist.gov/vuln/detail/CVE-2018-20060 Change-Id: I64fb4b1ae7c2814ad0ae11222bf8be531d4f40a5 Signed-off-by: Alexander Hughes <Alexander.Hughes@pm.me>		2020-06-25 19:38:01 +00:00
.github	Update Airship vulnerability link	2020-06-10 15:54:42 +00:00
doc	Update safety check for Python dependencies	2020-06-25 19:38:01 +00: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	Make zuul jobs reusable for internal zuul setup	2020-06-24 16:51:45 -05: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	Make zuul jobs reusable for internal zuul setup	2020-06-24 16:51:45 -05: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	Update safety check for Python dependencies	2020-06-25 19:38:01 +00:00
vcs-requirements.env	Uplift Promenade version in Pegleg requirements	2020-06-10 12:46:22 +00:00

README.rst

Pegleg

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.