CLI Tools on Prow

checkconfig

Mon, 01 Jan 0001 00:00:00 +0000

checkconfig loads the Prow configuration given with --config-path, --job-config-path and --plugin-config in order to validate it. Use checkconfig as a pre-submit for any repository holding Prow configuration to ensure that check-ins do not break anything.

config-bootstrapper

Mon, 01 Jan 0001 00:00:00 +0000

config-bootstrapper is used to bootstrap a configuration that would be incrementally updated by the config-updater Prow plugin.

When a set of configurations do not exist (for example, on a clean redeployment or in a disaster recovery situation), the config-updater plugin is not useful as it can only upload incremental updates. This tool is meant to be used in those situations to set up the config to the correct base state and hand off ownership to the plugin for updates.

generic-autobumper

Mon, 01 Jan 0001 00:00:00 +0000

This tool automates the version upgrading of images such as the prow.k8s.io Prow deployment. Its workflow is:

Given a local git repo containing the manifests of Prow component deployment, e.g., /config/prow/cluster folder in this repo.
Find out the most recent tags of given prefixes in gcr.io registry and modify the yaml files with them.
git-commit the change, push it to the remote repo, and create/update a PR, e.g., test-infra/pull/14249, for the change.

The cluster admins can upgrade the version of images by approving the PR.

invitations-accepter

Mon, 01 Jan 0001 00:00:00 +0000

The invitations-accepter tool approves all pending repository invitations.

Usage

example:

invitations-accepter --dry-run=false --github-token-path=/etc/github/oauth

using with GitHub Apps

invitations-accepter --dry-run=false --github-app-id=12345 --github-app-private-key-path=/etc/github/cert

mkpj

Mon, 01 Jan 0001 00:00:00 +0000

This is a placeholder page. Some contents needs to be filled.

mkpod

Mon, 01 Jan 0001 00:00:00 +0000

This is a placeholder page. Some contents needs to be filled.

Peribolos

Mon, 01 Jan 0001 00:00:00 +0000

Peribolos allows the org settings, teams and memberships to be declared in a yaml file. GitHub is then updated to match the declared configuration.

See the kubernetes/org repo, in particular the merge and update.sh parts of that repo for this tool in action.

Peribolos was the subject of a KubeCon talk: How Kubernetes Uses GitOps to Manage GitHub Communities at Scale

Etymology

A peribolos is a wall that encloses a court in Greek/Roman architecture.

Org configuration

Extend the primary prow config.yaml document to include a top-level orgs key that looks like the following:

Phony

Mon, 01 Jan 0001 00:00:00 +0000

phony sends fake GitHub webhooks.

Running a GitHub event manager

phony is most commonly used for testing hook and its plugins, but can be used for testing any externally exposed service configured to receive GitHub events (external plugins).

To get an idea of phony’s behavior, start a local instance of hook with this:

go run cmd/hook/main.go \
 --config-path=config/prow/config.yaml \
 --plugin-config=config/prow/plugins.yaml \
 --hmac-secret-file=path/to/hmac \
 --github-token-path=path/to/github-token

# Note:
# --hmac-secret-file is required for running locally, use the same hmac token for phony below

Usage

Once you have a running server that manages github webhook events, generate an hmac token (same process as in prow), and point a phony pull request event at it with the following: