Commit Graph

184 Commits

Author SHA1 Message Date
Tobin Feldman-Fitzthum
ffa50c4a44 Release notes for v0.6.0
Create new release notes file with content for
v0.6.0.

Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2023-06-08 09:05:20 -04:00
Jeremi Piotrowski
a2b6269d36 release-check-list: add AS and KBS steps
Signed-off-by: Jeremi Piotrowski <jpiotrowski@microsoft.com>
2023-05-20 02:16:36 +02:00
Zhongze Tang
aca326e7c8 Improve the doc
`asciidoctor` is not included in a freshly installed Ubuntu Server 22.04 LTS.
The doc enters wrong folder when configure `attestation-agent`

Signed-off-by: tangbao <i@tbis.me>
2023-05-09 09:25:17 -04:00
Larry Dewey
7ac2cc952a docs: Removing link for now
Due to some of the discussions in the community, we are removing this
for now.

Signed-off-by: Larry Dewey <larry.dewey@amd.com>
2023-05-01 09:37:40 -04:00
Larry Dewey
c29278b0c7 cleanup: Fixing some grammar and wording.
This adds some cleanup for the existing documentation, adds some
language specifiers for code blocks, as well as some fixes for minor
spelling issues.

Signed-off-by: Larry Dewey <larry.dewey@amd.com>
2023-05-01 09:37:40 -04:00
stevenhorsman
33d1a067d8 Update cloud-api-adaptor link in release notes
- Point to the released version of the Peer pods readme

Signed-off-by: stevenhorsman <steven@uk.ibm.com>
2023-04-17 11:19:14 -04:00
Tobin Feldman-Fitzthum
6a765dcbe1 Reorganize Quickstart Guide
Simplify quickstart guide to cover installation,
basic usage, encryption/signing, attestation.
Focus on the generic KBS.
Everything else is moved to other files. Pointers
to the relevant files are included where needed.

Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2023-04-14 16:05:54 -04:00
Tobin Feldman-Fitzthum
4b2f89ee47 SEV: Add annotations guide
The shim now supports a nmber of annotations for SEV(-ES),
meaning that we no longer need to modify the config file
to set things like the guest policy or kbs uri. Update
the quickstart guide to spread the news.

Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2023-04-14 16:05:54 -04:00
Tobin Feldman-Fitzthum
e7bac1044c SEV: Add guide overview
Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2023-04-14 16:05:54 -04:00
Tobin Feldman-Fitzthum
57ea613caa SEV: fix heading level
Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2023-04-14 16:05:54 -04:00
Tobin Feldman-Fitzthum
43e5f31851 Rename guides
Use snake_case and remove redundant guide name

Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2023-04-14 16:05:54 -04:00
Tobin Feldman-Fitzthum
5f8a0482cd Update release notes for v0.5.0
Add changes that have been made since middle of the release period.

Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2023-04-14 21:27:38 +02:00
Jeremi Piotrowski
dfb080c508 ssh-demo: Use KBS URI in demo
The offline_fs_kbc file needs to be updated to use a kbs-uri compatible name
for the key, and the container image has been regenerated to reference the
decryption key via kbs uri in it's annotation.

The image has two tags: encrypted and decrypted.

Fixes: #6604
Signed-off-by: Jeremi Piotrowski <jpiotrowski@microsoft.com>
2023-04-06 16:07:26 +02:00
Jeremi Piotrowski
04084b965e release-check-list: fix swapped cargo update flag
Signed-off-by: Jeremi Piotrowski <jpiotrowski@microsoft.com>
2023-04-04 10:26:21 +02:00
Jeremi Piotrowski
1a097620a2 release-check-list: fix crate name in step 2 to "attestation_agent
Signed-off-by: Jeremi Piotrowski <jpiotrowski@microsoft.com>
2023-04-04 10:26:21 +02:00
Jiale Zhang
141f31f476 QuickStart: Add Usage of CoCo Key Broker System
Fixed: #101

Signed-off-by: Jiale Zhang <zhangjiale@linux.alibaba.com>
2023-04-03 08:10:44 +02:00
Jiale Zhang
cf2cfd873d QuickStart: Reorganize and refined simplification
Fixed: #96

The current quick start is relatively lengthy,
this commit make the technology stacks for special HW separate markdown pages:

- Use simple-kbs to encrypt container image and deploy it on SEV: `guides/sev-guide.md`
- Use Verdictd to encrypt container image and deploy it on TDX: `guides/eaa-verdictd-guide.md`

Signed-off-by: Jiale Zhang <zhangjiale@linux.alibaba.com>
2023-04-03 08:10:44 +02:00
Pradipta Banerjee
bae433e921
Update architecture doc and diagrams (#111)
The patch includes number of fixes for the architecture doc.
Fixes the logical flow between the attestation agent and relying party
for all the diagrams.
Fixes the architecture diagram for process-based TEEs and replaces
references to inclavare with enclave-cc.
Added the architecture diagram for peer-pods approach.
Finally updated the markdown to use relative paths for the images to make
it easier for viewing during reviews and editors.

Signed-off-by: Pradipta Banerjee <pradipta.banerjee@gmail.com>
2023-04-01 15:41:59 +05:30
Dan Middleton
720bf64b69 Formatting fixups and date fix
Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2023-03-30 07:51:24 -05:00
Dan
5b1a1f478c Add KBS as a new feature
Co-authored-by: Jiale Zhang <652716685@qq.com>
Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2023-03-30 07:51:24 -05:00
Dan
96fe6d46a0 Add KBS Resource URI as a new feature.
Co-authored-by: Xynnn_ <xynnn@linux.alibaba.com>
Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2023-03-30 07:51:24 -05:00
Dan
06a9707741 Add SEV annotation config feature
Co-authored-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2023-03-30 07:51:24 -05:00
Dan Middleton
fe4521dbe4 Update security badge status
Since last release the final repos have added unit test coverage and
linting hooked into CI.

Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2023-03-30 07:51:24 -05:00
Dan Middleton
c078719588 Add enclave-cc / SGX support
Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2023-03-30 07:51:24 -05:00
Dan Middleton
d277154b22 Initial draft of v0.5 release notes
Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2023-03-30 07:51:24 -05:00
Dan Middleton
b3922ef78e Fix formatting
Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2023-03-03 16:21:26 -06:00
Dan Middleton
5eae0f00b7 Fix KBC release notes
Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2023-03-03 16:21:26 -06:00
Dan Middleton
88923984de Add docs links and release overview comment
Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2023-03-03 16:21:26 -06:00
Dan
fe4784640a Add oci-crypt link
Co-authored-by: Christophe de Dinechin <christophe@dinechin.org>
2023-03-03 16:21:26 -06:00
Dan
f6b7d4bffa Remove redundant KBS
Co-authored-by: Christophe de Dinechin <christophe@dinechin.org>
2023-03-03 16:21:26 -06:00
Dan
d5f6ccd76e Define KBS
Co-authored-by: Christophe de Dinechin <christophe@dinechin.org>
2023-03-03 16:21:26 -06:00
Dan
37d484813b Fix s390x naming
Co-authored-by: Christophe de Dinechin <christophe@dinechin.org>
2023-03-03 16:21:26 -06:00
Dan
5948dbe382 Update releases/v0.4.0.md
Co-authored-by: Christophe de Dinechin <christophe@dinechin.org>
2023-03-03 16:21:26 -06:00
Dan Middleton
d2d4bc2ed5 Remove SEV KBS limitation from release notes
Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2023-03-03 16:21:26 -06:00
Dan Middleton
94e09c394c release notes v0.4.0 initial commit
Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2023-03-03 16:21:26 -06:00
Fabiano Fidêncio
8207e74e01
Merge pull request #73 from fidencio/topic/ensure-the-template-is-listed
templates: Ensure the release-check-list template is displayed
2023-02-22 16:29:59 +01:00
Fabiano Fidêncio
7caa599c95 templates: Ensure the release-check-list template is displayed
It seems that we have to have a table with some basic information
otherwise GitHub won't be able to display the template information to
the users.

Signed-off-by: Fabiano Fidêncio <fabiano.fidencio@intel.com>
2023-02-22 16:22:40 +01:00
Fabiano Fidêncio
1409787e0d
Merge pull request #71 from fidencio/topic/add-a-release-check-list-template
templates: Add a release check list template
2023-02-22 16:16:11 +01:00
Fabiano Fidêncio
578b8444e6 templates: Add a release check list template
Let's have a release check list template that we can use to track the
release steps needed for each new release.

Signed-off-by: Fabiano Fidêncio <fabiano.fidencio@intel.com>
2023-02-22 16:15:41 +01:00
Dan Middleton
f540eac084 Reconcile steering committee list with MAINTAINERS
CNCF requires a MAINTAINERS file that matches our steering committee.

Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2023-02-13 21:17:43 +01:00
Ryan Savino
948ec86535 sev: update skopeo encrypt command to use 'docker' target
Fixes: #97

Signed-Off-By: Ryan Savino <ryan.savino@amd.com>
2023-02-10 16:32:27 -05:00
Thomas Fossati
514fabbc3b small typo
Signed-off-by: Thomas Fossati <thomas.fossati@arm.com>
2023-02-04 14:17:11 -06:00
Thomas Fossati
63139b3ada update ref to RATS architecture
update ref to RATS architecture, it's been published as RFC9334

Signed-off-by: Thomas Fossati <thomas.fossati@arm.com>
2023-02-04 14:17:11 -06:00
Fabiano Fidêncio
f688f82f06 quickstart: How to use a different KBC with enclave-cc
Let's add a small piece of documentation about what the users should do
in case they want to try enclave-cc with a different KBC.

Signed-off-by: Fabiano Fidêncio <fabiano.fidencio@intel.com>
2023-01-20 08:46:19 +01:00
Tobin Feldman-Fitzthum
8a8ff5af02 Update release notes
Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2023-01-19 18:36:35 +01:00
Tobin Feldman-Fitzthum
920e5fd3f9 Quickstart: change quay to ghcr
Avoid issues with quay support for encrypted images.
For now ghcr image is hosted via my gh.

Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2023-01-18 11:54:19 +01:00
Tobin Feldman-Fitzthum
63f79170a7 Quickstart: Update info on enabling debug console
Now we can use the debug console without rebuilding
the initrd.

Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2023-01-18 11:54:19 +01:00
Tobin Feldman-Fitzthum
a673039e03 quickstart: add KBS URI information
Soon this will be set via annotation and modiying the kata config
will not be required.

Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2023-01-18 11:54:19 +01:00
Unmesh Deodhar
130745e34a Remove outdated SEV documentation
Removing old instructions for SEV.

Signed-off-by: Unmesh Deodhar <udeodhar@amd.com>
2023-01-17 18:30:30 +01:00
Fabiano Fidêncio
9faf24a7f2 quickstart: Update the required vCPU numbers to 4
While preparing the `v0.3.0` release, we've noticed that using a VM with
2 vCPUs would lead to:
```
Name:           cc-operator-controller-manager-79797456f6-spmss
Namespace:      confidential-containers-system
...
Events:
  Type     Reason            Age    From               Message
  ----     ------            ----   ----               -------
  Warning  FailedScheduling  4m12s  default-scheduler  0/1 nodes are available: 1 Insufficient cpu. preemption: 0/1 nodes are available: 1 No preemption victims found for incoming pod.
```

And this is *NOT* something introduced between `v0.2.0` and `v0.3.0`, as
it also happen with the previous release.

For now, let's update the documentation accordingly and revisit this
after the release in case we need to really rely on deploying in nodes
with 2 vCPUs.

Signed-off-by: Fabiano Fidêncio <fabiano.fidencio@intel.com>
2023-01-17 15:34:38 +01:00