Last updated
Last updated
Pipekit integrates with Git providers such as GitHub and GitLab to provide a seamless gitops experience for your users. This guide will walk you through the steps to integrate them with Pipekit.
These examples assume you are self-hosting Pipekit on the subdomain pipekit.example.com
. Replace this with your actual domain.
Go to replacing example
with your github organization.
Click on "New GitHub App"
Fill in the details:
GitHub App name: [Choose a unique App name]
Homepage URL:
Callback URL:
Add a second Callback URL:
Tick "Request user authorization (OAuth) during installation"
Webhook URL:
Repository permissions:
Administration: Read & Write
Checks: Read & Write
Contents: Read & Write
Deployments: Read & Write
Pull requests: Read & Write
Webhooks: Read & Write
Subscribe to events:
Create
Pull request
Push
Repository
Click "Create GitHub App"
Generate a private key and download it as prompted.
Note down the App name, App ID, Client ID and generate a new Client Secret.
Populate the with the collected information and install Pipekit.
Install Pipekit and log in with .
Create an organization and cluster. Go back to the organization and click settings
and then press the GitHub button to authenticate the Org with GitHub.
Install the Github App into the repo(s) you wish Pipekit to interact with.
Go to your Organization settings in Pipekit and click on "GitLab" to authenticate your Organization with GitLab.
Enter a PAT that has the following scopes:
api
read_user
read_repository
Choose a random string for the gitProviders.gitlab.webhookSecret
and apply it to the Helm chart values. This will be used to automatically create a webhook in GitLab to post events to Pipekit.
Ensure a secure gitProviders.bitbucket.webhookSecret
is set. This is used to automatically create webhooks in BitBucket to notify Pipekit.
Go to your Organization settings in Pipekit and click on "BitBucket Data Center" to authenticate your Organization with GitLab.
Enter your HTTP access token that has the following rights:
PROJECT_READ
REPO_ADMIN
You have now successfully integrated your git provider with your Organization. This will allow you to use a number of Pipekit's features:
If you enable a Git Provider, a Kubernetes cron job will be installed into the cluster that will run every night to query your git provider for an updated list of Pipekit-accessible repositories and store them in the Pipekit database. This is done to ensure that Pipekit has the most up-to-date list of repositories to work with and prevents excessive API calls to your git provider.
Enable gitProviders.gitlab.enabled
in the to configure Pipekit to use GitLab.
Enable gitProviders.bitbucket.enabled
in the to configure Pipekit to use BitBucket.
If you haven't done so, continue to and then to start using Pipekit.
that run Workflows stored in your Git repositories.
Create and manage Pipes that use to trigger Workflows on GitHub events.
The features of Pipekit.
Manage
Manage through gitops.
Integrating with a Git provider such as GitHub, or GitLab