rookout/piper

MultiBranch Pipeline For Argo Workflows

Piper - Deprecated

⚠️ Important Notice: This project (Piper) is no longer actively maintained. We have moved to a new and improved repository for Piper. Please visit the following link for the latest updates and contributions:

New repository

Support and Contributions

As we focus our efforts on the new repository, we won't be actively addressing issues or accepting pull requests here. Feel free to reach out to us on the new repository for any questions, issues, or contributions.

Thank you for your support and understanding.

Happy coding!

New Piper Repository

Table of Contents

• Getting Started
• Reporting Issues
• How to Contribute
• License

Getting Started

Piper configures a webhook in git provider and listens to the webhooks sends. It will create a Workflow CRD out of branches that contains .workflows folder. This folder should contain declarations of the templates and main DAG that will be running. Finally, it will submit the Workflow as a K8s resource in the cluster. To access more detailed explanations, please navigate to the Documentation site.

piper-demo-1080.mov

Reporting Issues

If you encounter any issues or bugs while using Piper, please help us improve by reporting them. Follow these steps to report an issue:

1. Go to the Piper Issues page on GitHub.
2. Click on the "New Issue" button.
3. Provide a descriptive title and detailed description of the issue, including any relevant error messages or steps to reproduce the problem.
4. Add appropriate labels to categorize the issue (e.g., bug, enhancement, question).
5. Submit the issue, and our team will review and address it as soon as possible.

How to Contribute

If you're interested in contributing to this project, please feel free to submit a pull request. We welcome all contributions and feedback. Please check out our Contribution guidelines for this project

License

This project is licensed under the Apache License. Please see the LICENSE file for details.

piper's Issues

Feature: debug pause injection

Should be implemented using comments in PR.
Something like :
piper debug <template_name>
And return and kubectl exec <pod_name> command

Fix: missing parameters.yaml fail pipeline

Feature: Argo Workflows Server linter

Feature: skip-ci

Feature: concurrency for each repo/branch pipeline

Feature: Logger with severity level

CI: e2e tests

Closes #60

Fix: retry of workflow don't update the notification GitHub again

uses workflows.argoproj.io/resubmitted-from-workflow label

Feature: Argo Workflows Server direct submit

Feature: lint with Argo Workflows Server

Fix: webhook cleanup on e2e test

There is a race condition when pod restarted between deletion (old pod) and creation (new pod) with current implmention

Fix: health check don't check the webhook health

Feature: Workflow status management service

Fix: notification on failure before creation of CRD

CI: add code coverage

Feature: Label management

Let user to decide which label to use in config.

Feature: Graceful shutdown

Fix: notification atomic operation for multiple replicas

CI: add security scans

Feature: Add tag event to GitHub webhook handler