This tutorial goes over setting up your own TestGrid instance in Google Cloud Storage.
Usually, to get your tests to display in TestGrid, setting up an instance isn't necessary. Instead, add your tests to an existing configuration.
TestGrid consists of two major components; its "backend" controllers and its "frontend" user interface.
These two components communicate using data stored in a cloud storage provider. The controllers are responsible for keeping this data up-to-date. The user interface displays this data.
- The source for the backend controllers are in the cmd folder.
- Formats for the data layer are found in the pb folder.
- The frontend user interface isn't open source, but it can still be used as a service.
TestGrid depends on a configuration file to determine what it should display.
You can get a configuration file in multiple ways:
- Serialize it from a YAML configuration file you write yourself
- Have a Prow instance generate a configuration file with Configurator
The configuration file should be named "config" in cloud storage, and will be needed by every controller.
From a configuration file, controller programs fetch and generate the other necessary data files.
The Updater generates and maintains the grid data to be displayed. Each test's current state is stored in cloud storage.
The Summarizer generates and maintains a summary for each dashboard. These summaries are stored in cloud storage.
A TestGrid instance, like the one at testgrid.k8s.io, displays a particular configuration and state by default.
The TestGrid configuration located at gs://your-bucket/config can be rendered at
testgrid.k8s.io/r/your-bucket/.
- Frontend API endpoints are subject to change as development continues.
- The service account
[email protected]must be given permission to read from these files.