airship/pegleg
Code Issues Proposed changes
57a6c6a84e
pegleg/doc/source/getting_started.rst
Felipe Monteiro d80aa0bd8f docs: Update getting started documentation 
Currently the getting started documentation is somewhat incorrect:
usage of pip3 install is not necessary as "regular" usage of
pegleg entails using ./tools/pegleg.sh which uses the Pegleg
Docker image.

Also, the CLI guide doesn't include any useful examples so some
have been added.

Change-Id: I851b1c8b4f9c38672fce7b4a017e31882c7006ea
Depends-On: Iaa928ec2f777ed6f899d3b1790f5f9de613da9bb
2018-09-14 11:14:36 -06:00

2.0 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 Docker CE, as Pegleg relies on it for CLI execution.

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.