Pipekit Docs

Pipekit Quickstart

How to run a pipeline on Pipekit
The following signup flow is in private beta. Please shoot us an email at [email protected] if you'd like to be added to the Pipekit waitlist or to request a live demo.

Create an account

  1. 1.
    Go to https://pipekit.io and click, "Start Free Trial"
  2. 2.
    Fill out your basic user information, click the Captcha, and hit Submit
  3. 3.
    Check your email for a welcome email containing a link to confirm your account
  4. 4.
    Click the link to confirm your account and log in.

Connect your Github

When prompted, click "Connect Github". You will be routed to Github where you will be prompted to authorize which repos Pipekit will have access to. Either authorize Pipekit for all repos or only the repos where you'll keep pipeline code or configuration files.

Configure a pipeline

After connecting your Github, you'll be redirected to the Create Pipe page. If you are on another page, click the + icon in the nav bar to get to the Create Pipe page. Configure the pipeline by filling out the form using these steps:
  1. 1.
    Add a name for your pipeline. For now, let's call our pipeline DAG Example
  2. 2.
    Add a description. We'll use this description: A directed, acyclic graph
  3. 3.
    Select the repo where your configuration yaml file will live on Github
  4. 4.
    Enter the location of the pipeline configuration file. We'll be using dag-diamon.yaml for this example.
  5. 5.
    In the "Run Conditions" section, specify when a pipeline should run. Right now, set the condition to be Branch and master. You can also run pipelines off Git tags and use regex matching.
  6. 6.
    Click submit to create your pipeline
Completed Create Pipe example

Run your pipeline

On your computer, go to the repo you used in the section above. Add the dag-diamond.yaml file below, commit the change, and push it to your master branch.
git add .
git commit -m "Run pipeline"
git push origin master
Then click on the example pipeline in the pipes page. You will then see a list of pipeline runs that now has one entry. Click where it says "BRANCH: master" to see the pipeline result and the log output.
Last modified 1yr ago