A configuration organization tool.
Go to file
Ian H Pittwood 3a6e3d7cce Add pre-command decrypt option
Adds an option on all site commands to decrypt site files before
executing the command's actions. This option will be enabled by default.
If the command clones repository contents to a temporary directory, only
that temporary data will be decrypted.

Change-Id: Ic10c7196592c6d0e1c69a85b265259357ac28169
2019-12-19 14:52:27 -06:00
doc Add passphrase catalog override option 2019-12-10 20:40:31 +00:00
images/pegleg Fix OpenSUSE image build 2019-08-22 19:46:05 +00:00
pegleg Add pre-command decrypt option 2019-12-19 14:52:27 -06: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 Add pre-command decrypt option 2019-12-19 14:52:27 -06:00
tools Added YAML file linting 2019-12-09 16:43:45 +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 for using containerd 2019-12-13 17:32:10 +00:00
Pipfile.lock Uplift promenade for using containerd 2019-12-13 17:32:10 +00:00
README.rst Typo fix: getting started URL 2019-01-23 09:35:27 +01:00
requirements.txt Uplift promenade for using containerd 2019-12-13 17:32:10 +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 for using containerd 2019-12-13 17:32:10 +00:00

README.rst

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.