airship
/
pegleg
Code Issues Proposed changes
A configuration organization tool.
442 Commits 3 Branches 0 Tags 9.9 MiB
Python 98.4%
Shell 0.8%
Makefile 0.8%
Go to file
anthony.bellino 86c52e4c8c Gate fix for pegleg 
Remove default pip.conf as some packages are
not availablei from the mirror and cause
the image build jobs to fail.

Change-Id: I125360952190a4dc5cfb98647cd94dcf506f9b71
 		2021-08-03 17:21:53 -07:00
.github Update Airship vulnerability link 2020-06-10 15:54:42 +00:00
doc Edit cli.rst 2020-11-16 15:12:12 +00:00
images/pegleg Fix opensuse_15 image 2021-05-14 13:42:02 +00:00
pegleg Cache fernet keys when encrypting or decrypting 2021-01-19 15:26:11 +00: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 Fix failing check_pki_certs test 2021-05-04 16:26:33 +00:00
tools Gate fix for pegleg 2021-08-03 17:21:53 -07: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 fix: Fix Pegleg pep8 gate 2020-09-21 15:35:06 -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 to latest commit (k8s 1.20) 2021-05-05 05:02:14 +00:00
Pipfile.lock Uplift Promenade to latest commit (k8s 1.20) 2021-05-05 05:02:14 +00:00
README.rst Typo fix: getting started URL 2019-01-23 09:35:27 +01:00
requirements.txt Uplift Promenade to latest commit (k8s 1.20) 2021-05-05 05:02:14 +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 to latest commit (k8s 1.20) 2021-05-05 05:02:14 +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.