You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit d387a4b
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+35-19Lines changed: 35 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,40 +26,59 @@ The topology is controlled by the `main.clusterGroupName` field in `values-globa
26
26
27
27
Azure deployments use peer-pods, which provision confidential VMs (`Standard_DCas_v5` family) directly on the Azure hypervisor. Bare metal deployments use layered images and hardware TEE features directly.
28
28
29
-
## Current version (5.*)
29
+
## Current version (8.*)
30
30
31
-
Breaking change from v4. Uses GA releases of the CoCo stack with Kyverno-based initdata injection.
31
+
Breaking change from v5. Upgrades to OSC 1.13 / Trustee 1.2, adds full airgap (disconnected) deployment support, and introduces experimental KubeVirt TDX VM workloads.
32
32
33
-
-**5.0** — Kyverno-based `cc_init_data` injection (replaces MutatingAdmissionPolicy), OSC 1.12 / Trustee 1.1 GA, external chart repositories, self-signed certificates via cert-manager, multi-cluster support via ACM. Requires OCP 4.19.28+.
34
-
-**5.1** — Bare metal support for Intel TDX and AMD SEV-SNP via NFD auto-detection. Currently tested on SNO (Single Node OpenShift) configurations only.
35
-
-**5.2** — NVIDIA H100 confidential GPU support for bare metal (`baremetal-gpu` clusterGroup). Adds GPU Operator, IOMMU configuration, CC Manager, and sample CUDA workload.
36
-
-**5.3** — DRY refactor of trustee and kyverno overrides, Kyverno CRD label fix, pattern infrastructure update.
37
-
-**5.4** — Firmware reference values workflow for bare metal attestation via veritas. Adds `collect-firmware-refvals.sh`, RVPS integration, and hardened attestation policy (trustee-chart v0.5.0).
38
-
-**5.5** — Trustee-chart v0.7.0 (td_attributes.debug path fix). Unified reference value collection for Azure and bare metal via veritas container.
-**Operator upgrade:** OSC 1.12 → 1.13, Trustee 1.1 → 1.2. Breaking API changes in KBS configuration and RVPS reference value format.
37
+
-**Airgap support:** Full disconnected deployment on bare metal via a single mirror-registry. Includes `oc-mirror` imageset configs, `airgap-post-install.sh` for bootstrap (CatalogSources, IDMS/ITMS, NeverContactSource policy normalisation, ArgoCD CA injection, git HTTP server), and a step-by-step operational runbook at `airgap/DEPLOY-RUNBOOK.md`.
38
+
-**Chart architecture:** trustee-chart moved to OCI Helm artifact (`quay.io/validatedpatterns/trustee:0.10.0`). Kyverno chart vendored under `charts/vendor/`. External charts (sandboxed-containers, sandboxed-policies) remain OCI.
39
+
-**TDX MachineConfig:** QGS socket port `socket_port=0` now deployed via MachineConfig drop-in (replaces manual `sed` workaround).
40
+
-**DCAP collateral:**`collect-dcap-collateral.sh` uses `pcsclient.py fetch -p E5` with `jq` fixup for QeIdentity (Red Hat OSC 1.13 disconnected TDX procedure).
41
+
-**Experimental:** KubeVirt TDX confidential VMs (`charts/all/kubevirtconfidential/`, `charts/all/kubevirtvm/`). Disabled by default. Requires Intel TDX hardware and KubeVirt post-v1.8.4 for full QGS attestation. See chart READMEs for details.
For air-gapped bare metal environments, see [`airgap/DEPLOY-RUNBOOK.md`](airgap/DEPLOY-RUNBOOK.md) for the full operational procedure. The runbook covers:
- Phase E: Intel DCAP collateral and TDX attestation
61
+
- Phase F: Verification and pass/fail checklist
62
+
63
+
**Prerequisites for airgap:**
64
+
- A jump host with internet access (for `oc-mirror`) and network access to the target cluster
65
+
-`docker.io/library/registry:2` container running as the mirror registry (setup documented in Phase 0)
66
+
-`scripts/git-http-server.py` serving pattern repos over smart HTTP (required by the patterns-operator's go-git client)
67
+
- All operator images, OCI Helm charts, and workload images mirrored via `airgap/imageset-config-4.22.yaml`
68
+
50
69
## Setup
51
70
52
71
### Prerequisites
53
72
54
73
**Azure deployments:**
55
74
56
-
- OpenShift 4.19.28+ cluster on Azure (self-managed via `openshift-install` or ARO)
75
+
- OpenShift 4.22+ cluster on Azure (self-managed via `openshift-install` or ARO)
57
76
- Azure `Standard_DCas_v5` VM quota in your target region (these are confidential computing VMs and are not available in all regions). See the note below for more details.
58
77
- Azure DNS hosting the cluster's DNS zone
59
78
60
79
**Bare metal deployments:**
61
80
62
-
- OpenShift 4.19.28+ cluster on bare metal with Intel TDX or AMD SEV-SNP hardware
81
+
- OpenShift 4.22+ cluster on bare metal with Intel TDX or AMD SEV-SNP hardware
63
82
- BIOS/firmware configured to enable TDX or SEV-SNP
64
83
- Available block devices for LVMS storage (auto-discovered)
65
84
- For Intel TDX: an Intel PCS API key from [api.portal.trustedservices.intel.com](https://api.portal.trustedservices.intel.com/)
@@ -74,12 +93,12 @@ Breaking change from v4. Uses GA releases of the CoCo stack with Kyverno-based i
74
93
75
94
These scripts generate the cryptographic material and attestation reference values needed by Trustee. Run them once before your first deployment.
76
95
77
-
1.`bash scripts/gen-secrets.sh` — generates KBS key pairs, PCCS certificates/tokens (for bare metal), and copies `values-secret.yaml.template` to `~/values-secret-coco-pattern.yaml`
96
+
1.`bash scripts/gen-secrets.sh` — generates KBS key pairs, sealed-secrets signing keys, and copies `values-secret.yaml.template` to `~/values-secret-coco-pattern.yaml`
-**Azure:**`make collect-azure-refvals` — pulls PCR measurements from the dm-verity image via veritas. Saves to `~/.coco-pattern/measurements.json`.
80
99
-**Bare metal:**`make collect-firmware-refvals` — computes firmware measurements from OCP release artifacts via veritas. Saves to `~/.coco-pattern/firmware-reference-values.json`. For bare metal, also uncomment the `firmwareReferenceValues` section in `~/values-secret-coco-pattern.yaml`.
81
100
- See [docs/firmware-reference-values.md](docs/firmware-reference-values.md) for detailed workflow and options.
82
-
3. Review and customise `~/values-secret-coco-pattern.yaml` — this file is loaded into Vault and provides secrets to the pattern. For bare metal, uncomment the PCCS secrets section and provide your Intel PCS API key.
101
+
3. Review and customise `~/values-secret-coco-pattern.yaml` — this file is loaded into Vault and provides secrets to the pattern.
83
102
84
103
> **Note:**`gen-secrets.sh` will not overwrite existing secrets. Delete `~/.coco-pattern/` if you need to regenerate.
85
104
@@ -95,7 +114,7 @@ These scripts generate the cryptographic material and attestation reference valu
95
114
1. Set `main.clusterGroupName: trusted-hub` in `values-global.yaml`
96
115
2. Deploy the hub cluster: `./pattern.sh make install`
97
116
3. Wait for ACM (`MultiClusterHub`) to reach `Running` state on the hub
98
-
4. Provision a second OpenShift 4.19.28+ cluster on Azure for the spoke
117
+
4. Provision a second OpenShift 4.22+ cluster on Azure for the spoke
99
118
5. Import the spoke into ACM with label `clusterGroup=azure-spoke`
100
119
(see [importing a cluster](https://validatedpatterns.io/learn/importing-a-cluster/))
101
120
6. ACM will automatically deploy the `azure-spoke` clusterGroup applications (sandboxed containers, workloads) to the imported cluster
@@ -107,8 +126,7 @@ These scripts generate the cryptographic material and attestation reference valu
107
126
- Run `make detect-hardware` after NFD is deployed to detect your hardware profile automatically
3. Run `bash scripts/gen-secrets.sh` to generate KBS keys and PCCS secrets
110
-
4. For Intel TDX: uncomment the PCCS secrets in `~/values-secret-coco-pattern.yaml` and provide your Intel PCS API key
111
-
5.`./pattern.sh make install`
129
+
4.`./pattern.sh make install`
112
130
6. Wait for the cluster to reboot nodes (MachineConfig updates for TDX/SEV-SNP kernel parameters and vsock)
113
131
114
132
> **Note:** Bare metal support is currently tested on SNO (Single Node OpenShift) configurations. Multi-node bare metal clusters are expected to work but have not been validated yet.
@@ -120,9 +138,7 @@ The system auto-detects your hardware:
120
138
-**RuntimeClass**`kata-cc` is created automatically pointing to the correct handler (`kata-tdx` or `kata-snp`)
121
139
- Both `kata-tdx` and `kata-snp` RuntimeClasses are deployed; only the one matching your hardware has schedulable nodes
122
140
- MachineConfigs are deployed for both `master` and `worker` roles (safe on SNO where only master exists)
123
-
- PCCS and QGS services deploy unconditionally; DaemonSets only schedule on Intel nodes via NFD labels
124
-
125
-
Optional: pin PCCS to a specific node with `bash scripts/get-pccs-node.sh` and set `baremetal.pccs.nodeSelector` in the baremetal chart values.
141
+
- DCAP QGS (Quote Generation Service) deploys on Intel nodes via NFD labels; offline collateral mode (no PCCS server required)
126
142
127
143
For GPU-enabled deployments (`intel-tdx-gpu` or `amd-snp-gpu` profiles):
0 commit comments