Commit Graph

184 Commits

Author SHA1 Message Date
Fabiano Fidêncio
fdf5f4b2d2 quickstart: Update description of the qemu-tdx runtime class
Now it's prepared to be used with Verdictd and EAA KBC.

Signed-off-by: Fabiano Fidêncio <fabiano.fidencio@intel.com>
2023-01-17 15:34:38 +01:00
Fabiano Fidêncio
a7f1716eae quickstart: Use v0.3.0 as example, instead of v0.2.0
As we're about to release v0.3.0, let's update the quickstart guide so
it's easier for folks to try it out using the correct latest release.

Signed-off-by: Fabiano Fidêncio <fabiano.fidencio@intel.com>
2023-01-17 15:34:38 +01:00
Fabiano Fidêncio
41d23524f7 quickstart: Adapt to the operator using kustomize
Let's adapt the instructions to using kustomize for deploying the sample
ccruntime custom resource.

Signed-off-by: Fabiano Fidêncio <fabiano.fidencio@intel.com>
2023-01-17 15:34:38 +01:00
Wainer dos Santos Moschetta
0c2ea2f441 quickstart: Add a note on prequisites about SELinux
The operator does not work(**) with SELinux enabled and enforced. Added
a note about it on the prequisites section.

(**) https://github.com/confidential-containers/operator/issues/115

Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
2023-01-16 18:57:09 +01:00
Wainer dos Santos Moschetta
6b5d0edfd2 quickstart: Add a note about troubleshooting image pull issue
The CoCo Pod might fail when *IfNotPresent* policy is set. Add some
words about that on the troubleshoot section.

Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
2023-01-16 18:57:09 +01:00
Wainer dos Santos Moschetta
9368189fa4 quickstart: note about checking the image is encrypted
skopeo can leave the image unencrypted without any notice. Added a
comment about checking it is not the case for an image built by the
user.

Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
2023-01-16 18:57:09 +01:00
Wainer dos Santos Moschetta
d91527685f quickstart: Detail the key spec for SEV offline KBC
Mentioned that the encryption key for SEV offline KBC should have 32
bytes and be base64 encoded.

Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
2023-01-16 18:57:09 +01:00
Wainer dos Santos Moschetta
43c12f208d quickstart: Add a note about a bug on sevctl for RHEL/Fedora
There is a bug(**) on sevctl affecting some versions of the package on RHEL
and Fedora. Added a note mentioning it might be needed to build the tool
from the sources.

(**) https://bugzilla.redhat.com/show_bug.cgi?id=2037963

Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
2023-01-16 18:57:09 +01:00
Wainer dos Santos Moschetta
bf7b50c696 quickstart: Update link to sevctl project
sevctl repository at enarx organization is now read-only as the development moved to
https://github.com/virtee/sevctl. The URL was updated in the quickstart.

Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
2023-01-16 18:57:09 +01:00
hairongchen
f381a4a594 update according to comments
Signed-off-by: hairongchen <hairong.chen@intel.com>
2023-01-13 21:07:33 +01:00
hairongchen
019e9fb93b update according to comments
Signed-off-by: hairongchen <hairong.chen@intel.com>
2023-01-13 21:07:33 +01:00
hairongchen
372bd93a5a update according to comments
Signed-off-by: hairongchen <hairong.chen@intel.com>
2023-01-13 21:07:33 +01:00
hairongchen
934a9e1ed9 update workload deployment using hardware mode with encrypted and
cosign signed image

Signed-off-by: hairongchen <hairong.chen@intel.com>
2023-01-13 21:07:33 +01:00
stevenhorsman
96977efa8c Authenticated registry support
Add new feature for authenticated registry support and point to
the design docs. We might have more info on how to set it up in future
but that is probably linked to configuration the guest image for
offline_fs_kbc configuration in non-TEE scenario and separated for
other confidential hardware, so we might need the quickstart guide
to be broken down into separate topics first

Signed-off-by: stevenhorsman <steven@uk.ibm.com>
2022-12-02 16:21:49 +01:00
Unmesh Deodhar
6af93de108 Adding extra information about the flag.
Adding extra information about the flag in skopeo copy command.

Signed-off-by: Unmesh Deodhar <udeodhar@amd.com>

Fixing newline change.

Fixing the newline change.

Signed-off-by: Unmesh Deodhar <udeodhar@amd.com>

Removing sudo for docker commands

Assuming user has setup the docker correctly, we do not need to use sudo for docker commands.

Signed-off-by: Unmesh Deodhar <udeodhar@amd.com>

quickstart: Filling gaps in the SEV documentation.

Fixing a couple of permission issues and command line parameters for skopeo.

Signed-off-by: Unmesh Deodhar <udeodhar@amd.com>
2022-11-22 13:48:52 -05:00
Tobin Feldman-Fitzthum
8df30c9b91 Blank release notes for v0.3.0
Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2022-11-21 16:30:17 +01:00
Shirong Hao
5e3e36fe3b quickstart: fix Ansible docker_container module install command
Signed-off-by: Shirong Hao <shirong@linux.alibaba.com>
2022-11-21 16:29:59 +01:00
Fabiano Fidêncio
40d3394918 quickstart: Add a note about Enclave CC limitations with Kind
Enclave CC requires the Kind cluster to be prepared with
`/opt/confidential-containers` to **not** be mounted on an overlayfs,
but rather being part of the `hostPath` mount.

Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
Signed-off-by: Fabiano Fidêncio <fabiano.fidencio@intel.com>
2022-11-10 12:13:12 +01:00
Fabiano Fidêncio
9b797d0ddf quickstart: Add a note about QEMU limitation with Kind / Minikube
It's a known limitation that QEMU based runtime classes will not work
with Kind or Minikube, leading to:
```
Events:
  Type     Reason                  Age   From               Message
  ----     ------                  ----  ----               -------
  Normal   Scheduled               42s   default-scheduler  Successfully assigned default/nginx-kata-qemu to minikube
  Warning  FailedCreatePodSandBox  9s    kubelet            Failed to create pod sandbox: rpc error: code = Unknown desc = failed to create containerd task: failed to create shim task: Failed to Check if grpc server is working: rpc error: code = DeadlineExceeded desc = timed out connecting to vsock 3189232285:1024: unknown
```

This needs further debug in order to get to the root cause of the issue,
and potentially to a fix.  However, for now, we should make sure that we
document such limitation.

One issue already reported about this is
https://github.com/confidential-containers/operator/issues/124, and
that's also been observed by Pradipta during the early tests of v0.1.0.

Signed-off-by: Fabiano Fidêncio <fabiano.fidencio@intel.com>
2022-11-10 12:13:12 +01:00
Tobin Feldman-Fitzthum
47df4e83e9
Update SEV quickstart (#71)
KBS is no longer required for unencrypted images with SEV

Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2022-11-10 13:06:39 +05:30
Dan Middleton
c0d557f55c Quickstart remove redundant hardware section
This is tracked in release notes. Maintain that info in one place.

Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2022-11-10 08:29:06 +01:00
Mikko Ylinen
b37b99b0f5 enclave-cc: add quickstart guide
Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2022-11-10 00:24:17 +01:00
Tobin Feldman-Fitzthum
beb33499de Update release announcement
Use static release announcement for minor releases

Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2022-11-09 18:50:09 +01:00
Mikhail Sakhnov
2e9341400a Update architecture.md
Typo fix: worklooads -> workloads

Signed-off-by: Mikhail Sakhnov <mikhail@skhnv.me>
2022-11-09 14:09:46 +01:00
Mikko Ylinen
4117d21788
quickstart: update operator installation steps (#73)
The operator dropped the deploy/deploy.yaml based deployment and moved
to a kustomize based one so update the docs to reflect that change.

Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2022-11-09 15:06:04 +05:30
Tobin Feldman-Fitzthum
8052fcc250 Start release notes for v0.2.0
Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2022-11-08 18:02:34 +01:00
Steve Horsman
5f6c2a8185
ssh-demo: Update runtimeClassName (#59)
Update runtimeClassName from kata-cc to kata to reflect the operator
changes

Signed-off-by: stevenhorsman <steven@uk.ibm.com>
2022-11-05 11:35:04 +05:30
Tobin Feldman-Fitzthum
8e32fab213 Use special markdown note
Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2022-11-04 15:56:36 -04:00
Suraj Deshmukh
0f8e7409ff trust_model_personas: Remove white spaces
Signed-off-by: Suraj Deshmukh <suraj.deshmukh@microsoft.com>
2022-10-14 12:13:00 -05:00
Suraj Deshmukh
ce4073225e trust_model_personas: Fix sub-topic indentation
Signed-off-by: Suraj Deshmukh <suraj.deshmukh@microsoft.com>
2022-10-14 12:13:00 -05:00
James Magowan
c6af54631a doc: Trust Model Personas
Add Trust Model Personas
 Include references and links to prior art

Signed-off-by: James Magowan <MAGOWAN@uk.ibm.com>
2022-10-11 14:38:05 +02:00
Tobin Feldman-Fitzthum
628a71f730 Add release announcement
Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2022-09-29 16:01:18 -04:00
Tobin Feldman-Fitzthum
8b2c3b12f0 Add tip about creating issues
Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2022-09-29 16:01:18 -04:00
Ryan Savino
5d2a74700e sev: fix RHEL mysql client package
set RHEL mysql client package

Signed-Off-By: Ryan Savino <ryan.savino@amd.com>
2022-09-29 13:09:36 -04:00
Ryan Savino
d6ef69eba1 sev: updated SEV release documentation
updated SEV release documentation

Signed-Off-By: Ryan Savino <ryan.savino@amd.com>
2022-09-29 16:10:09 +02:00
Steve Horsman
b72b821a63
Add sample encrypted container image instructions (#60)
Add instructions for how to set-up, create and validate creating a
workload from the sample encrypted container image

Fixes: #confidential-containers/operator#77
Signed-off-by: stevenhorsman <steven@uk.ibm.com>
2022-09-29 15:02:22 +01:00
Pradipta Banerjee
fd75db206a Simplify the operator install instructions
Signed-off-by: Pradipta Banerjee <pradipta.banerjee@gmail.com>
2022-09-28 16:10:26 +02:00
Christophe de Dinechin
361991be5b Fix formatting of the list of the runtime classes
The output of the list of runtime classes shows all wrong when rendered by GitHub.

Signed-off-by: Christophe de Dinechin <christophe@dinechin.org>
2022-09-28 15:50:40 +02:00
fossabot
c1f39578fe
Add license scan report and status (#32)
Signed off by: fossabot <badges@fossa.com>
2022-09-28 10:17:53 +02:00
Christophe de Dinechin
07020331a9 Add instructions on how to deploy a single-node cluster locally
We have a script that does most of the gruntwork as part of the CI, but can be
used locally on a machine to quickly setup a single-node test cluster. Let's
document that option.

Signed-off-by: Christophe de Dinechin <christophe@dinechin.org>
Suggested-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2022-09-28 09:40:52 +02:00
Ariel Adam
97102f53b8 documentation: Confidential Containers architecture
Describe and explain the project architecture.

Signed-off-by: Ariel Adam <aadam@redhat.com>
Co-authored-by: Dan Middleton <dan.middleton@intel.com>
Co-authored-by: Samuel Ortiz <sameo@rivosinc.com>
2022-09-28 09:24:11 +02:00
Tobin Feldman-Fitzthum
51d7c25570 Add troubleshooting guide
Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2022-09-28 09:14:55 +02:00
Dan Middleton
06a76e63bc Release Notes: Add security limitations
Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2022-09-26 22:46:46 +02:00
Tobin Feldman-Fitzthum
35b303498d Standardize documentation filenames.
snake_case to match typical Rust style.

Only applies to documentation not files LICENSE
or CODEOWNERS or README.md

Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2022-09-26 18:09:03 +02:00
Pradipta Banerjee
e9c2f0f6a3
Use the correct deployment manifest for the operator (#42)
The operator-demo folder contains instruction to recreate the
ssh demo. This demo works only with the older code in the
operator `ccv0` branch. The code in `main` branch has deviated
significantly and the existing ssh demo will not work when using
the manifest from the main branch.


Signed-off-by: Pradipta Banerjee <pradipta.banerjee@gmail.com>
2022-09-26 15:54:32 +05:30
Tobin Feldman-Fitzthum
28f113934b Seperate release notes and create quickstart guide
Quickstart guide is a durable entrypoint for new users
that will be updated for each release.

Release notes are updates about the current release.

Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2022-09-22 11:21:48 +02:00
Jiale Zhang
022facff4e Release notes: Building encrypted image and deploy it with EAA.
Signed-off-by: Jiale Zhang <zhangjiale@linux.alibaba.com>
2022-09-21 10:39:31 +02:00
Wang, Arron
40618d7751 release: Add trusted ephemeral storage description
Signed-off-by: Wang, Arron <arron.wang@intel.com>
2022-09-20 09:58:12 +02:00
Christophe de Dinechin
f60e8a2067
Features/first release limitations (#45)
* Define Continuous Integration acronym before using it

This is a common term, but better to follow good practices about documentation.

Signed-off-by: Christophe de Dinechin <christophe@dinechin.org>

* Add some definitions and terminology

At this stage in the release (i.e. quite early, nobody knowing what we are
doing), Better to define three-letter acronym or components before we actually
use the terminology.

Signed-off-by: Christophe de Dinechin <christophe@dinechin.org>

* Add a description of some of the limitations

List some of the limitations that we have, trying to also indicate where this is
going in the relatively short term.

Signed-off-by: Christophe de Dinechin <christophe@dinechin.org>

Signed-off-by: Christophe de Dinechin <christophe@dinechin.org>
2022-09-15 11:44:06 +01:00
Ariel Adam
c76a4305c1
Create release_notes_09_2022.md (#43)
* Create release_notes_09_2022.md

* Update releases/release_notes_09_2022.md

Co-authored-by: James O. D. Hunt <james.o.hunt@intel.com>

* Update releases/release_notes_09_2022.md

Co-authored-by: James O. D. Hunt <james.o.hunt@intel.com>

* Update releases/release_notes_09_2022.md

Co-authored-by: James O. D. Hunt <james.o.hunt@intel.com>

* Update releases/release_notes_09_2022.md

Co-authored-by: James O. D. Hunt <james.o.hunt@intel.com>

* Update releases/release_notes_09_2022.md

Co-authored-by: James O. D. Hunt <james.o.hunt@intel.com>

* Update releases/release_notes_09_2022.md

Co-authored-by: James O. D. Hunt <james.o.hunt@intel.com>

* Update release_notes_09_2022.md

* Adding the diagrams for the architecture 

Adding the diagrams for the COCO architecture

Co-authored-by: James O. D. Hunt <james.o.hunt@intel.com>
2022-09-14 10:29:10 +03:00