Skip to main content

Git

Use a gitProtocol check to verify repository access with Git credentials.

git-protocol-check.yaml
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
name: git-pull-push
spec:
gitProtocol:
- name: git-pull-push
username:
valueFrom:
secretKeyRef:
key: username
name: gitea
password:
valueFrom:
secretKeyRef:
key: password
name: gitea
repository: http://gitea-http.gitea:3000/gitea_admin/test_repo.git
schedule: "@every 5m"
FieldDescriptionScheme
name*

Name of the check, must be unique within the canary

string

password*

Password or token for repository authentication

EnvVar

repository*

Git repository URL

string

username*

Username for repository authentication

EnvVar

filename

Optional file name used by the check

string

description

Description for the check

string

display

Expression to change the formatting of the display

Expression

icon

Icon for overwriting default icon on the dashboard

Icon

labels

Labels for check

[map[string]string]

markFailOnEmpty

If a transformation or datasource returns empty results, the check should fail

boolean

metrics

Metrics to export from

[]Metrics

test

Evaluate whether a check is healthy

Expression

transform

Transform data from a check into multiple individual checks

Expression