https://github.com/eruvanos/flightplan
AWS CDK like tool to code Concourse pipelines (with autocompletion.)
https://github.com/eruvanos/flightplan
code-generation concourse python3 yaml
Last synced: 8 months ago
JSON representation
AWS CDK like tool to code Concourse pipelines (with autocompletion.)
- Host: GitHub
- URL: https://github.com/eruvanos/flightplan
- Owner: eruvanos
- Created: 2020-08-12T20:32:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-24T01:25:52.000Z (over 2 years ago)
- Last Synced: 2025-03-14T07:02:49.451Z (8 months ago)
- Topics: code-generation, concourse, python3, yaml
- Language: Python
- Homepage:
- Size: 91.8 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://get-ytt.io/)).
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.
```bash
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.
```bash
fp quickstart
```
### Import existing pipeline file
Convert a pipeline yaml and render a flightplan `.py` file.
```bash
fp import
```
### Import existing pipeline from fly
Convert a pipeline from fly and render a flightplan `.py` file.
```bash
fp get
```
> 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
```bash
fp synth
```
### Direct Fly Set Pipeline
```bash
fp set
```
## Examples
Quickstart hello world example:
```python
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())
```