Skip to content

Commit

Permalink
Merge pull request #45 from ruomengh/kernel-doc
Browse files Browse the repository at this point in the history
Update docs
  • Loading branch information
ruomengh authored Apr 8, 2024
2 parents dd3e003 + 1e3d27a commit ac70853
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ It requires a full chain integrity measurement on the launch-time or runtime env
to guarantee "consistent behavior in an expected way" of confidential
computing environment for tenant's zero-trust use case.

CCNP aims to help users establish a chain of trust for cloud-native workloads by providing
cloud-native level confidential computing primitives, including container measurements,
event logs, and confidential computing (CC) reports.


## How to Install CCNP

Expand All @@ -27,13 +31,12 @@ CCNP runs on Intel TDX guest. Thus, you will need TDX host and guest for CCNP de

| CPU | Host OS | Host packages | Guest OS | Guest packages | Attestation packages |
|---|---|---|---|---|---|
| Intel® Emerald Rapids | Ubuntu 23.10| TDX early preview referring to [here](https://github.com/canonical/tdx) | Ubuntu 23.10 | Build guest image using [CVM image rewriter](/tools/cvm-image-rewriter/README.md) | Install PCCS and QGS on host from [here](https://download.01.org/intel-sgx/sgx-dcap/1.20/linux/distro/ubuntu23.10-server/)

_NOTE: The Platform certificate caching service (PCCS) is used to retrieve and cache PCK certificates locally to your cluster from Intel's Platform Certificate Service. This is necessary to attest the authenticity of a TD guest before a workload is started in it. The Quote Generate Service (QGS) runs on the host in a specialized enclave to generate and use TD quotes. For convenient setup these can run inside a Docker container. Learn more at [here]( https://download.01.org/intel-sgx/sgx-dcap/1.17/linux/docs/Intel_TDX_DCAP_Quoting_Library_API.pdf). The PCCS and QGS are used to get Quote for a TD guest. They need to be installed on TDX hosts._
| Intel® Emerald Rapids | Ubuntu 23.10| TDX early preview referring to [here](https://github.com/canonical/tdx?tab=readme-ov-file#4-setup-tdx-host) | Ubuntu 23.10 | Build a guest image for CCNP using [CVM image rewriter](/tools/cvm-image-rewriter/README.md) | Setup remote attestation on host referring to [here](https://github.com/canonical/tdx?tab=readme-ov-file#8-setup-remote-attestation-on-host-and-td-guest)

### CCNP Service Deployment in Confidential VM

It supports to deploy CCNP services as DaemonSets in Kubernetes cluster or docker containers on a single confidential VM. Please refer to [CCNP deployment guide](deployment/README.md).
CCNP will run as a DaemonSet in a Kubernetes cluster or as a container in a docker environment on a single confidential VM (CVM).
Refer to [CCNP deployment guide](deployment/README.md) and choose a deployment model.

### CCNP SDK Usage

Expand Down
9 changes: 9 additions & 0 deletions deployment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,15 @@ Start a TD using [qemu-test.sh](../tools/cvm-image-rewriter/qemu-test.sh) or [st
$ sudo ./start-virt.sh -i <guest image>
```
Check the kernel version. It should be CCNP kernel as below.
```
$ uname -ar | grep -i ccnp
Linux tdx-guest 6.5.0-1003-intel-opt #3.ccnp.1
```
If above output is empty, refer to [Build CCNP Kernel](#build-ccnp-kernel) to generate CCNP kernel packages. Then install the packages in the TD and make it as default kernel.
## Build CCNP images
Run script [build.sh](../container/build.sh) to generate CCNP images. It will generate 3 images and push them to user specific registry. Learn more details in the [README.md](../container/README.md).
Expand Down

0 comments on commit ac70853

Please sign in to comment.