flightplan 0.1.2

Code based description for Concourse pipelines

Flight plan - Plan your Concourse Pipeline with ease

AWS CDK like tool to code Concourse pipelines (with autocompletion.)

Why not stick with YAML

Writing YAML files feels not as heavy as XML, but still lacks the comfort of autocompletion and some kind of structuring (Beside anchors or tools like YTT).

The vision of Flightplan does not stop with replacing YAML, the real benefit starts with component libraries, which ease the setup of pipelines.

Furthermore these components can be updated, which make all improvements automatically available to all pipelines.

Features

• Convert:
  • YAML -> Python
  • Python -> YAML
• Fly integration
  • Set pipeline
  • Get pipeline
• Shiped examples
  • Hello world
  • more to come

Disclaimer - Alpha

The package is still in alpha. Upcoming versions may include breaking changes.

Upcoming

• Provide high level components that handle common use cases

Setup

Flightplan requires Python 3.8 and higher.

Install FlightPlan

Flightplan requires fly to be installed on path.

pip3 install flightplan

Usage

If you start with Flightplan it is recommended to have a look on the quickstart examples, which are shipped within the cli.

If you want to migrate an existing pipeline you can use

• fp import - to convert YAML to Python
• fp get ... - to get and convert a running pipeline

Quickstart

Generate a basic pipeline example.

fp quickstart

Import existing pipeline file

Convert a pipeline yaml and render a flightplan .py file.

fp import <src.yaml> <target.py>

Import existing pipeline from fly

Convert a pipeline from fly and render a flightplan .py file.

fp get <fly_target> <pipeline_name> <target.py>

Static and dynamic vars will be imported as Var(str), if the type of the field is limited to an int or Enum type.

Synthesize yaml from flightplan .py file

fp synth <src.py> <target.yaml>

Direct Fly Set Pipeline

fp set <fly-target> <pipeline_name> <src.py>

Examples

Quickstart hello world example:

from flightplan.render import *

pipe = Pipeline(
    resource_types=[],
    resources=[],
    jobs=[
        Job(
            name="job-hello-world",
            public=True,
            plan=[
                Task(
                    task="hello-world",
                    config=TaskConfig(
                        platform="linux",
                        image_resource=ImageResource(
                            type="docker-image",
                            source=dict(repository="busybox", tag="latest"),
                        ),
                        run=Command(path="echo", args=["hello world"]),
                        inputs=[],
                        outputs=[],
                    ),
                )
            ],
        )
    ],
)

if __name__ == "__main__":
    print(pipe.synth())