gitjob
Job controller to launch kubernetes jobs based on git event
Building
make
Running
-
Download helm chart releases from releases pages
-
Install the helm chart.
kubectl create namespace gitjob
helm install gitjob --namespace gitjob ./path/to/your/helm/tarballUsage
gitjob allows you to launch kubernetes jobs based on git event. By default it uses polling to receive git event, but also can be configured to use webhook.
Quick start
To run kubectl apply on a github repo:
- First, create a serviceAccount and rbac roles so that you have sufficient privileges to create resources.
apiVersion: v1
kind: ServiceAccount
metadata:
name: kubectl-apply
---
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
name: kubectl-apply
rules:
- apiGroups:
- "apps"
resources:
- 'deployments'
verbs:
- '*'
---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
name: kubectl-apply
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: Role
name: kubectl-apply
subjects:
- kind: ServiceAccount
name: kubectl-apply- Create a gitjob CRD that apply manifest when git repo changes.(Using polling)
apiVersion: gitjob.cattle.io/v1
kind: GitJob
metadata:
name: example
namespace: default
spec:
syncInterval: 15 // in seconds, default to 15
git:
branch: master
repo: https://github.com/StrongMonkey/gitjob-example
jobSpec:
template:
spec:
serviceAccountName: kubectl-apply
restartPolicy: "Never"
containers:
- image: "bitnami/kubectl:latest"
name: kubectl-apply
command:
- kubectl
args:
- apply
- -f
- deployment.yaml
workingDir: /workspace/sourceNote: Git repository will be cloned under /workspace/source by default.
Two environmental variables: COMMIT, EVENT_TYPE will be added into your job spec.
- A kubernetes job will be created with specified job template.
NAME COMPLETIONS DURATION AGE
example-3af7c 1/1 5s 24hPrivate repo
For private repo that needs credential:
- Create a kubernetes secret that contains ssh-private-key.
kubectl create secret generic ssh-key-secret --from-file=ssh-privatekey=/path/to/private-key- Apply a gitjob CRD with secret specified.
apiVersion: gitjob.cattle.io/v1
kind: GitJob
metadata:
name: example-private
spec:
git:
branch: master
repo: [email protected]:StrongMonkey/priv-repo.git
gitSecretName: ssh-key-secret
gitHostName: github.com
jobSpec:
template:
spec:
serviceAccountName: kubectl-apply
restartPolicy: "Never"
containers:
- image: "bitnami/kubectl:latest"
name: kubectl-apply
command:
- kubectl
args:
- apply
- -f
- deployment.yaml
workingDir: /workspace/sourceWebhook
gitjob can be configured to use webhook to receive git event. This currently supports Github, GitLab, Bitbucket, Bitbucket Server and Gogs.
- Create a gitjob that is configured with webhook.
apiVersion: gitjob.cattle.io/v1
kind: GitJob
metadata:
name: example-webhook
namespace: default
spec:
git:
branch: master
repo: https://github.com/StrongMonkey/gitjob-example
jobSpec:
template:
spec:
serviceAccountName: kubectl-apply
restartPolicy: "Never"
containers:
- image: "bitnami/kubectl:latest"
name: kubectl-apply
command:
- kubectl
args:
- apply
- -f
- deployment.yaml
workingDir: /workspace/source- Create an ingress that allows traffic.
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
name: webhook-ingress
namespace: gitjob
spec:
rules:
- host: your.domain.com
http:
paths:
- path: /
pathType: Prefix
backend:
serviceName: gitjob
servicePort: 80Note: To configure a HTTPS receiver, make sure you have proper TLS configuration on your ingress
- Create Your webhook that sends payload to
http://your.domain.com/.
You can choose which event to send when creating the webhook. Gitjob currently supports push and pull-request event.
API reference
API types are defined in here
Contribution
Part of this project is built upon Tekton.
License
Copyright (c) 2020 Rancher Labs, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent