A configuration organization tool.
Go to file
Ian H. Pittwood 0e46d134c1 Implement Pipenv dependency management
Pipenv is a tool that brings better package dependency management to
python. It can automatically create and manage virtualenv as well as
managing package dependencies using Pipfile and Pipfile.lock. Adding
this dependency manager into Airship projects will decrease package
version conflicts between projects and help increase security through
hash validation of packages and vulnerability scans.

Changes:
- Imports requirements.txt type files into Pipfile
- Pipenv dependency management in tox
- Switches Safety package for "pipenv check", an implementation of
Safety
- Adds `-e` flag on VCS dependencies to resolve good versions on all
packages
- Unpins or loosens pins on "dev"-type packages

Pipenv Docs: https://docs.pipenv.org/en/latest/

Helpful Pipenv Guide: https://realpython.com/pipenv-guide/

Change-Id: I47e7e7b440d76103b4984499e6ffce4482a59353
2019-08-12 09:10:42 -05:00
doc Support regenerating PKI 2019-08-06 17:15:02 +00:00
images/pegleg Update base image from leap15.0 to leap15.1 2019-07-11 17:27:53 -07:00
pegleg Merge "Support regenerating PKI" 2019-08-06 18:45:24 +00:00
releasenotes Add releasenotes 2018-11-28 02:48:40 -06:00
site_yamls/site CLI capability to generate and encrypt passphrases 2019-01-29 16:24:31 -06:00
tests Support regenerating PKI 2019-08-06 17:15:02 +00:00
tools Update Pegleg docs jobs 2019-05-20 08:16:16 -05:00
.dockerignore Update to UCP layout standard 2018-03-05 07:42:00 -06:00
.gitignore Update .gitignore 2018-10-31 15:08:42 -05: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 Implement Pipenv dependency management 2019-08-12 09:10:42 -05:00
LICENSE Initial commit 2018-01-26 15:47:15 -06:00
Makefile Standardize Pegleg code with YAPF 2019-07-25 17:28:18 +00:00
Pipfile Implement Pipenv dependency management 2019-08-12 09:10:42 -05:00
Pipfile.lock Implement Pipenv dependency management 2019-08-12 09:10:42 -05:00
README.rst Typo fix: getting started URL 2019-01-23 09:35:27 +01:00
requirements.txt Implement Pipenv dependency management 2019-08-12 09:10:42 -05:00
setup.py Update references from openstack to opendev 2019-04-24 15:22:53 -05:00
tox.ini Implement Pipenv dependency management 2019-08-12 09:10:42 -05: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.