airship/pegleg
Code Issues Proposed changes
pegleg/doc/source/getting_started.rst
Matt McEuen 15b5062f84 Refresh docs for Airship 
Now that Pegleg is a proud member of the OpenStack Airship family,
this PS makes a few updates to reflect this change, in terms
of project name (s/pegleg/airship-pegleg/), doc links, and
old-skool UCP vs Airship terminology.
Http URLs have also been updated to https.

Change-Id: I27bc725b3cf3c1ccee20221722733807af51cd44
2018-08-06 09:04:58 -05:00

2.2 KiB
Raw Blame History

Getting Started

What is Pegleg?

Pegleg is a document aggregator that will aggregate all the documents in a repository and pack them into a single YAML file. This allows for operators to structure their site definitions in a maintainable directory layout, while providing them with the automation and tooling needed to aggregate, lint, and render those documents for deployment.

For more information on the documents that Pegleg works on see Document Fundamentals.

Basic Usage

Before using Pegleg, you must:

  1. Clone the Pegleg repository:
git clone https://git.airshipit.org/airship-pegleg
  1. Install the required packages in airship-pegleg/src/bin/pegleg:
pip3 install -r airship-pegleg/src/bin/pegleg/requirements.txt -r airship-pegleg/src/bin/pegleg/test-requirements.txt

3. Clone the repos containing your site definition libraries into the local filesystem where Pegleg is running, as Pegleg can only work with files available in the local directory.

You will then be able to use all of Pegleg's features through the CLI. See CLI for more information.