From b62e9d9377211c7179591d8f5c66599405ce5344 Mon Sep 17 00:00:00 2001 From: Ryan Savino Date: Tue, 10 Dec 2024 15:34:52 -0600 Subject: [PATCH] docs: added machine list table and label columns The added machine table links the machine's assigned labels to the jobs required labels. Corrected some mistakes and label assignments. Formatting. Fixes: #316 Signed-Off-By: Ryan Savino --- docs/DEVELOPMENT.md | 34 +++++++++++++++++++++++----------- 1 file changed, 23 insertions(+), 11 deletions(-) diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md index e8480548..b6dd0c75 100644 --- a/docs/DEVELOPMENT.md +++ b/docs/DEVELOPMENT.md @@ -92,22 +92,34 @@ In order to be merged your opened pull request (PR) should pass the static analy The e2e tests jobs are executed on a variety of CcRuntime, configurations and platforms. These jobs that require confidential hardware (Intel TDX, AMD SEV, IBM SE, etc...) run on bare-metal machines and are often referred as "TEE tests". The remaining tests (a.k.a "Non-TEE") are executed on Virtual Machines (VM) deployed on-demand. +This is a list of the bare-metal machines and VMs that are utilized by the project for CI testing: + +| Machine | Type | TEE Capability | Assigned Labels | +| --- | --- | --- | --- | +| s390x-runner-01 | virtual | Non-TEE | s390x, s390x-large | +| s390x-runner-02 | virtual | Non-TEE | s390x | +| tdx-ubuntu-24.04 | bare-metal | TDX | self-hosted, Linux, X64, tdx | +| coco-ci-amd-rome-001 | bare-metal | SEV | self-hosted, Linux, X64, sev-es, sev | +| coco-ci-amd-milan-001 | bare-metal | SNP | self-hosted, Linux, X64, sev-snp, sev-es | + The following jobs will check for regressions on the default CcRuntime: -|Job name | TEE | OS | VMM | -|---|---|---|---| -|e2e-pr / operator tests (kata-qemu, s390x) | Non-TEE | Ubuntu 22.04 (s390x) | QEMU | -|e2e-pr / operator tests (kata-qemu, ubuntu-20.04) | Non-TEE | Ubuntu 20.04 | QEMU | -|e2e-pr / operator tests (kata-qemu, ubuntu-22.04) | Non-TEE | Ubuntu 22.04 | QEMU | -|e2e-pr / operator tests (kata-qemu-tdx, tdx) | TDX | Ubuntu 24.04 | QEMU | -|e2e-pr / operator tests (kata-qemu-sev, coco-ci-amd-rome-001, ) | SEV | Ubuntu 22.04 | QEMU | -|e2e-pr / operator tests (kata-qemu-snp, coco-ci-amd-milan-001) | SNP | Ubuntu 22.04 | QEMU | +| Job Name | TEE | OS | VMM | runs-on | +| --- | --- | --- | --- | --- | +| e2e-pr / operator tests (kata-qemu, ubuntu-20.04) | Non-TEE | Ubuntu 20.04 | QEMU | ubuntu-20.04 | +| e2e-pr / operator tests (kata-qemu, ubuntu-22.04) | Non-TEE | Ubuntu 22.04 | QEMU | ubuntu-22.04 | +| e2e-pr / operator tests (kata-qemu, s390x-large) | Non-TEE | Ubuntu 22.04 | QEMU | s390x-large | +| e2e-pr / operator tests (kata-qemu-tdx, tdx) | TDX | Ubuntu 24.04 | QEMU | tdx | +| e2e-pr / operator tests (kata-qemu-sev, sev) | SEV | Ubuntu 22.04 | QEMU | sev-es | +| e2e-pr / operator tests (kata-qemu-snp, sev-snp) | SNP | Ubuntu 22.04 | QEMU | sev-snp | Additionally the following jobs will check regressions on the enclave-cc CcRuntime: -| Job name | TEE | OS | -|---|---|---| -|operator enclave-cc e2e tests| Intel SGX (Simulated Mode) | Ubuntu 22.04 | +| Job name | TEE | OS | Required Labels | +| --- | --- | --- | --- | +| operator enclave-cc e2e tests | Intel SGX (Simulated Mode) | Ubuntu 22.04 | ubuntu-22.04 | + +The required labels specified for a job will determine what machine it lands on by matching the machine's assigned labels. Some of the e2e jobs are not triggered automatically. We recommend to trigger them only after some rounds of reviews to avoid wasting resources. They can be triggered only by writing `/test` in PR's comment.