A configuration organization tool.
Go to file
Sergiy Markin b0f823aec7 Uplift shipyard
This PS uplifts shipyard dependency

Change-Id: I07fc6ee98ff3af66713eb8eed41ce3b7f295e4ca
2023-08-31 20:46:16 +00:00
.github Update Airship vulnerability link 2020-06-10 15:54:42 +00:00
doc Airflow stable 2.6.2 2023-08-30 16:07:28 +00:00
images/pegleg Add gettext package to docker images 2023-06-21 10:25:22 -05:00
pegleg Cache fernet keys when encrypting or decrypting 2021-01-19 15:26:11 +00:00
releasenotes Uplift k8s, promenade and shipyard dependencies 2022-07-20 18:40:42 -05:00
site_yamls/site CLI capability to generate and encrypt passphrases 2019-01-29 16:24:31 -06:00
tests Pegleg focal upgrade 2023-05-02 15:05:45 +00:00
tools Airflow stable 2.6.2 2023-08-30 16:07:28 +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 Airflow stable 2.6.2 2023-08-30 16:07:28 +00:00
LICENSE Initial commit 2018-01-26 15:47:15 -06:00
Makefile Restored ubuntu_bionic image build 2023-06-07 21:02:28 +00:00
README.rst Typo fix: getting started URL 2019-01-23 09:35:27 +01:00
bindep.txt Pegleg focal upgrade 2023-05-02 15:05:45 +00:00
requirements-direct.txt Uplift shipyard 2023-08-31 20:46:16 +00:00
requirements-frozen.txt Uplift shipyard 2023-08-31 20:46:16 +00:00
requirements.txt Restored ubuntu_bionic image build 2023-06-07 21:02:28 +00:00
setup.py Refactors pegleg CLI to use single commands 2019-12-17 19:32:28 +00:00
test-requirements.txt Restored ubuntu_bionic image build 2023-06-07 21:02:28 +00:00
tox.ini Airflow stable 2.6.2 2023-08-30 16:07:28 +00:00
vcs-requirements.env Uplift shipyard 2023-08-31 20:46:16 +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.