To deploy a Prow cluster, configure the following service accounts in the Google Cloud project you own.
| Service account name | Usage | Required roles |
|---|---|---|
| sa-gke-kyma-integration | Runs integration tests on a GKE cluster. | Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyVersions.useToDecrypt,roles/cloudkms.cryptoKeyVersions.useToEncrypt,roles/resourcemanager.projects.get), Compute Admin (roles/compute.admin), Compute Network Admin,Kubernetes Engine Admin (roles/container.admin), Kubernetes Engine Cluster Admin (roles/container.clusterAdmin), DNS Administrator (roles/dns.admin), Service Account User (roles/iam.serviceAccountUser), Storage Admin (roles/storage.admin) |
| sa-kyma-artifacts | Saves release and development artifacts to the GCS bucket. | Storage Object Admin (roles/storage.objectAdmin) |
| sa-vm-kyma-integration | Runs integration tests on k3d. | Compute Instance Admin (beta) (roles/compute.instanceAdmin), Compute OS Admin Login (roles/compute.osAdminLogin), Service Account User (roles/iam.serviceAccountUser) |
| sa-gcs-plank | Schedules the Pod requested by a Prow Job. | TBD |
| sa-crier | Reports Prow Job statuses to GitHub. | Service Account User |
The cert-manager Cluster Role is the only Cluster Role required to deploy a Prow cluster. It manages the following resources:
- `certificates.certmanager.k8s.io`
- `issuers.certmanager.k8s.io`
- `clusterissuers.certmanager.k8s.io`
- `configmaps`
- `secrets`
- `events`
- `services`
- `pods`
- `ingresses.extensions`
NOTE: There is no separate Cluster Role for Tiller. Instead, the
cluster-adminKubernetes role is granted to Tiller's service account.
Following roles exist on Prow cluster:
| Role name | Managed resources | Available actions |
|---|---|---|
| deck | - prowjobs.prow.k8s.io - pods/log |
get, list get |
| horologium | - prowjobs.prow.k8s.io - pods |
delete, list delete, list |
| plank | - prowjobs.prow.k8s.io - pods |
create, list, update create, list, delete |
| sinker | - prowjobs.prow.k8s.io - pods |
delete, list delete, list |
| hook | - prowjobs.prow.k8s.io - configmaps |
create, get get, update |
| tide | - prowjobs.prow.k8s.io |
create, list |
| crier | - prowjobs.prow.k8s.io |
get, watch list, patch |
Prow starts tests when triggered by certain Github events. For security reasons, the trigger plugin ensures that the test jobs are run only on pull requests (PR) created or verified by trusted users.
All members of the kyma-project organization are considered trusted users. The trigger plugin starts jobs automatically when a trusted user opens a PR or commits changes to a PR branch. Alternatively, trusted collaborators can start jobs manually through the /test all, /test {JOB_NAME} and /retest commands, even if a particular PR was created by an external user.
All users that are not members of the kyma-project organization are considered external contributors. The trigger plugin does not automatically start test jobs on PRs created by external contributors. Furthermore, external contributors are not allowed to manually run tests on their own PRs.
NOTE: External contributors can still trigger tests on PRs created by trusted users.
Actions on Prow can be triggered only by webhooks. To configure them you must create two Github Secrets on your Prow cluster:
hmac-token- used to validate webhookoauth-token- stores the access token used by the GitHub bot
Follow the official Prow documentation to learn how to create the Secrets.