Commit Graph

247 Commits

Author SHA1 Message Date
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
fossabot
cbd3a74fb3 Add license scan report and status
Signed off by: fossabot <badges@fossa.com>
2022-06-23 12:11:24 -05:00
Johanan Liebermann
bc0c64a849 Fix language in docs
- Fix random capitalization of words.
- Fix whitespace issues.
- Improve phrasing to increase clarity.
- Fix punctuation.
- Fix typos.

Signed-off-by: Johanan Liebermann <jliebermann@microsoft.com>
2022-06-01 15:56:07 -05:00
Mikko Ylinen
0d6ee2805b docs: update CNCF Security White Paper references
CNCF TAG-Security announced version 2 of the Security White Paper
and that broke the links to version 1.

Fix the links and move to v2 of the white paper..

Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2022-06-01 13:58:10 +02:00
Samuel Ortiz
0843942b31 Merge pull request #34 from sameo/topic/governance
governance: Initial definition
2022-05-04 19:36:01 +02:00
Samuel Ortiz
2f895dd7bb governance: Initial definition
* Roles defintion
* Steering Committee initial composition
* SC scope and Responsibilities

Fixes #9

Signed-off-by: Samuel Ortiz <samuel.e.ortiz@protonmail.com>
2022-05-04 18:33:33 +01:00
Ariel Adam
23fb69a6dc Merge pull request #49 from fitzthum/maintainers
Add community maintainers
2022-05-04 19:20:54 +03:00
Tobin Feldman-Fitzthum
e3ec506329 Add community maintainers
Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2022-05-04 11:07:51 -04:00
Samuel Ortiz
fda0750531 templates: Project creation request 2022-04-13 09:49:47 +02:00
Samuel Ortiz
74d1af3561 CNCF onboarding template wording fixes 2022-03-14 08:16:18 +01:00
Samuel Ortiz
a9cb03a6e4 CNCF onboarding issue template
Make it easier to contribute to the CNCF onbarding effort.
2022-03-14 08:12:22 +01:00
James Magowan
9fc29c7c19 docs: Trust Model Introduction
Add a introduction to Trust Model (Part of Issue #28).
Include references and links to prior art

Follow on Pull Requests will include sections corresponding to orthogonal ways of considering cloud native approaches relevent to the trust model
Specifically including
   - Personas
   - Lifecycle
   - Trusted Execution Boundary Location
   - Secured v unsecured TEE Base Image

Signed-off-by: James Magowan <magowan@uk.ibm.com>
2022-03-09 22:07:01 +01:00
James Magowan
f6507c35ed docs : Add CODEOWNERS file
Adding a CODEOWNERS file as documented here -> https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners#about-code-owners

Seeding with the github team -> https://github.com/orgs/confidential-containers/teams/documentation-maintainers/members

Looking to start discussion on
Who else should be added?
Are those listed comfortable being on the list?

Signed-off-by: James Magowan <magowan@uk.ibm.com>
2022-03-03 14:40:51 +01:00
Jakob Naucke
90c46f8209 Document CCv0 demo image (#19)
- In the operator documentation,
  - use the CCv0 demo image as payload,
  - reference the SSH demo.
- In the SSH demo documentation,
  - use the `kata-cc` runtime,
  - reference the operator demo.

Signed-off-by: Jakob Naucke <jakob.naucke@ibm.com>
2021-12-23 19:46:31 +05:30
Tobin Feldman-Fitzthum
3e8db5b9b1 Add SEV Demo
Instructions for using SEV with CCv0.

Signed-off-by: Tobin Feldman-Fitzthum <tobin@ibm.com>
2021-12-14 19:24:55 +01:00
Jakob Naucke
6bf298930a Add simple asciinema.org recording
This recording demonstrates the ease of deploying a confidential
container and its confidentiality through a memory check.

Signed-off-by: Jakob Naucke <jakob.naucke@ibm.com>
2021-12-07 16:31:08 +01:00
Jakob Naucke
127b9a4fca Add documentation on a demo SSH image
There is now a public container image for the SSH demo with publicised
keys. Add the respective references.

Signed-off-by: Jakob Naucke <jakob.naucke@ibm.com>
2021-12-02 14:28:09 +01:00
Pradipta Banerjee
4090df7b60 Add demo details for CCv0 operator 2021-12-02 11:15:33 +01:00
James Magowan
86543a72bb doc: Extending Roadmap
correct formatting

Signed-off-by: James Magowan <magowan@uk.ibm.com>
2021-11-25 15:06:17 +01:00
James Magowan
0a81645466 doc: Extending Roadmap
Addressing PR comments
Adding some diagrams for short term roadmap

Signed-off-by: James Magowan magowan@uk.ibm.com
2021-11-25 15:06:17 +01:00
James Magowan
0d25143ca4 doc: Extending Roadmap
Adding considerations for mid and longer term roadmap

Signed-off-by: James Magowan magowan@uk.ibm.com
2021-11-25 15:06:17 +01:00
Jakob Naucke
8c3a47ab67 Add SSH demo
Add basic documentation, Dockerfile, k8s and sandbox config for a demo
pod with SSH public key authentication.

Documentation on encrypting and running the image is omitted as of now,
for this is a more general topic which will require separate attention.

Signed-off-by: Jakob Naucke <jakob.naucke@ibm.com>
2021-11-24 07:11:28 +01:00
Dan Middleton
e1f910d28f Link CONTRIBUTING in README
Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2021-11-12 14:34:23 -06:00
Dan Middleton
2e2f993dfc Remove Kata specific sections from CONTRIBUTING.md
Remove kata runtime guidance and backporting sections that focus
on kata 1.1 vs 2.0 repo organization.
Update go-lang guidance to remove kata specifics.

Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2021-11-12 14:34:23 -06:00
Dan Middleton
8d33aeb3b9 Refactor master to main
Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2021-11-12 14:34:23 -06:00
Dan Middleton
006dcf676d Refactor CONTRIBUTING from kata to CC
Formatting fixes and update kata references to Confidential Containers.
Entire sections that may be kata specific will be removed in a separate commit for clarity.

Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2021-11-12 14:34:23 -06:00
Dan Middleton
0bd0c08263 Add kata contributing guide as basis
Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2021-11-12 14:34:23 -06:00
Dan Middleton
26f3a55a99 Add README, CoC, LICENSE and PR review guide
Add files from Confidential-Containers and Kata orgs

Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2021-11-12 14:19:26 -06:00
James Magowan
fb57505a1e doc: Adding README links
Adding links into top level README

Signed-off-by: James Magowan magowan@uk.ibm.com
2021-11-12 11:25:12 +01:00
Dan
21612c7656 Add container isolation (#5)
* Format markdown

Set column width to 100 characters to facilitate future PR reviews.

Signed-off-by: Dan Middleton <dan.middleton@intel.com>

* Add container isolation to Overview

Reflect community discussions from October 2021 recognizing prior work
with container isolation and future work to comprehensively address
the scope implied by Confidential Containers.

Signed-off-by: Dan Middleton <dan.middleton@intel.com>
2021-11-10 14:30:03 +00:00
James Magowan
84f25fe318 Adding Initial Overview (#3)
* Adding Initial Overview

Adding Initial Overview covering Why/How, What.

Signed-off-by: James Magowan magowan@uk.ibm.com

* Adding Initial Overview

Responding to PR comments

Signed-off-by: James Magowan magowan@uk.ibm.com
2021-10-20 21:14:04 +01:00
Tobin Feldman-Fitzthum
dc621048d2 alignment doc first pass 2021-10-18 11:46:31 -04:00
Ariel Adam
ba38889701 Update Roadmap.md
Adding comments from James Magowan
2021-10-12 15:48:30 +02:00
Ariel Adam
e19a3190e5 Create Roadmap.md
An initial draft for the roadmap file
2021-10-12 15:48:30 +02:00
Ariel Adam
a2673ae421 Initial commit 2021-10-04 18:40:23 +03:00