Skip to content

README.md

Latest commit

 

History

History
78 lines (56 loc) · 5.6 KB

README.md

File metadata and controls

78 lines (56 loc) · 5.6 KB
Raw

Prow Images

This directory includes a sub directory for every Prow component and is where all binary and container images are built. You can find the main packages here. For details about building the binaries and images see build_test_update.md.

Cluster Components

Prow has a microservice architecture implemented as a collection of container images that run as Kubernetes deployments. A brief description of each service component is provided here.

Core Components

  • crier reports on ProwJob status changes. Can be configured to report to gerrit, github, pubsub, slack, etc.
  • deck presents a nice view of recent jobs, command and plugin help information, the current status and history of merge automation, and a dashboard for PR authors.
  • hook is the most important piece. It is a stateless server that listens for GitHub webhooks and dispatches them to the appropriate plugins. Hook's plugins are used to trigger jobs, implement 'slash' commands, post to Slack, and more. See the prow/plugins directory for more information on plugins.
  • horologium triggers periodic jobs when necessary.
  • prow-controller-manager manages the job execution and lifecycle for jobs that run in k8s pods. It currently acts as a replacement for plank
  • sinker cleans up old jobs and pods.

Merge Automation

  • tide manages retesting and merging PRs once they meet the configured merge criteria. See its README for more information.

Optional Components

  • branchprotector configures github branch protection according to a specified policy
  • exporter exposes metrics about ProwJobs not directly related to a specific Prow component
  • gerrit is a Prow-gerrit adapter for handling CI on gerrit workflows
  • hmac updates HMAC tokens, GitHub webhooks and HMAC secrets for the orgs/repos specified in the Prow config file
  • jenkins-operator is the controller that manages jobs that run on Jenkins. We moved away from using this component in favor of running all jobs on Kubernetes.
  • tot vends sequential build numbers. Tot is only necessary for integration with automation that expects sequential build numbers. If Tot is not used, Prow automatically generates build numbers that are monotonically increasing, but not sequential.
  • status-reconciler ensures changes to blocking presubmits in Prow configuration does not cause in-flight GitHub PRs to get stuck
  • sub listen to Cloud Pub/Sub notification to trigger Prow Jobs.

CLI Tools

  • checkconfig loads and verifies the configuration, useful as a pre-submit.
  • config-bootstrapper bootstraps a configuration that would be incrementally updated by the updateconfig Prow plugin
  • generic-autobumper automates image version upgrades (e.g. for a Prow deployment) by opening a PR with images changed to their latest version according to a config file.
  • invitations-accepter approves all pending GitHub repository invitations
  • mkpj creates ProwJobs using Prow configuration.
  • mkpod creates Pods from ProwJobs.
  • peribolos manages GitHub org, team and membership settings according to a config file. Used by kubernetes/org
  • phaino runs an approximation of a ProwJob on your local workstation
  • phony sends fake webhooks for testing hook and plugins.

Pod Utilities

These are small tools that are automatically added to ProwJob pods for jobs that request pod decoration. They are used to transparently provide source code cloning and upload of metadata, logs, and job artifacts to persistent storage. See their README for more information.

Base Images

The container images in images are used as base images for Prow components.

TODO: undocumented

Deprecated