airship
/
pegleg
Code Issues Proposed changes
A configuration organization tool.
433 Commits 3 Branches 0 Tags 9.9 MiB
Python 98.4%
Shell 0.8%
Makefile 0.8%
Go to file
Phil Sphicas c7b903a6ea Cache fernet keys when encrypting or decrypting 
The PEGLEG_PASSPHRASE and PEGLEG_SALT environment variables are used to
generate the fernet key for encryption and decryption of site documents,
and the global passphrase and salt are used to generate the fernet key
for global documents.

This change caches the resulting fernet keys to avoid recalculating them
for each document that needs to be encrypted or decrypted, resulting in
a small time savings.

Change-Id: I7b7e77a4740e7abb54efce2fcb3cca6d84a9d7d4
 		2021-01-19 15:26:11 +00: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 Include LibYAML in container builds 2020-09-25 01:01:20 +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 Accelerate YAML operations with LibYAML 2020-09-25 01:01:20 +00:00
tools Ignore binary files when whitespace linting 2020-09-22 04:52:18 +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 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 Update pip package versions in preparation of pip 20.3 2020-10-19 12:24:38 -04:00
Pipfile.lock Update pip package versions in preparation of pip 20.3 2020-10-19 12:24:38 -04:00
README.rst Typo fix: getting started URL 2019-01-23 09:35:27 +01:00
requirements.txt Update pip package versions in preparation of pip 20.3 2020-10-19 12:24:38 -04: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 Update pip package versions in preparation of pip 20.3 2020-10-19 12:24:38 -04: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.