mirror of
https://github.com/confidential-containers/confidential-containers.git
synced 2025-10-22 07:52:15 +00:00
Compare commits
42 Commits
v0.7.0
...
v0.9.0-alp
Author | SHA1 | Date | |
---|---|---|---|
|
165dba4572 | ||
|
aaefc563e9 | ||
|
7861710aad | ||
|
55b7108a8e | ||
|
a57f058ba3 | ||
|
ea0eb314f3 | ||
|
b00e015a5d | ||
|
08c031e9fb | ||
|
8de20e19e0 | ||
|
243224fc4a | ||
|
fe829c58f2 | ||
|
6341e73c27 | ||
|
110f616894 | ||
|
36ef4d0e3d | ||
|
3861810143 | ||
|
e573995129 | ||
|
1f8b197915 | ||
|
28c94a52a5 | ||
|
51915ac2d5 | ||
|
b36a57e530 | ||
|
fccda517ed | ||
|
03e17fea1a | ||
|
d82359bcb0 | ||
|
c49e27c5a2 | ||
|
ec2e350168 | ||
|
96496b1cab | ||
|
8f890f0430 | ||
|
f09ae8b215 | ||
|
1f3e6c19fd | ||
|
4ce6104f39 | ||
|
10c1bf7e54 | ||
|
c9bb59973f | ||
|
7413d8e4a3 | ||
|
5edd4826ca | ||
|
62d5e2f2f6 | ||
|
16099d2328 | ||
|
99a84b7d1e | ||
|
4f69d4ea76 | ||
|
f51c7faa49 | ||
|
643a9b269f | ||
|
5e5a1edd78 | ||
|
702093defe |
49
.github/ISSUE_TEMPLATE/meeting-request.yml
vendored
Normal file
49
.github/ISSUE_TEMPLATE/meeting-request.yml
vendored
Normal file
@@ -0,0 +1,49 @@
|
||||
---
|
||||
name: Meeting Request
|
||||
description: Request for a CoCo Zoom room for a meeting
|
||||
title: "[Meeting Request]"
|
||||
labels: meeting-request
|
||||
assignees:
|
||||
- fitzthum
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Fill in this form to request a Zoom meeting with the official CoCo Zoom.
|
||||
All meetings will be public and recorded.
|
||||
- type: input
|
||||
id: title
|
||||
attributes:
|
||||
label: Meeting Title
|
||||
description: What is the title of the meeting?
|
||||
placeholder: Ex. CoCo-IO Discussion
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Meeting Description
|
||||
description: What is the purpose of the meeting
|
||||
placeholder: Ex. coordinate search for extraterrestrial life
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: when
|
||||
attributes:
|
||||
label: Meeting date and time
|
||||
description: When is the meeting?
|
||||
placeholder: Ex. September 8th, 2023 at 10 PM EST
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: recurrence
|
||||
attributes:
|
||||
label: Meeting recurrence
|
||||
description: When should this meeting repeat?
|
||||
options:
|
||||
- Never
|
||||
- Weekly
|
||||
- Biweekly
|
||||
- Monthly
|
||||
validations:
|
||||
required: true
|
192
.github/ISSUE_TEMPLATE/release-check-list.md
vendored
192
.github/ISSUE_TEMPLATE/release-check-list.md
vendored
@@ -8,130 +8,112 @@ assignees: ''
|
||||
|
||||
# v<TARGET_RELEASE>
|
||||
|
||||
## Code freeze
|
||||
## Overview
|
||||
|
||||
1. - [ ] Update image-rs to use the latest commit from ocicrypt-rs
|
||||
|
||||
* https://github.com/confidential-containers/image-rs/blob/main/Cargo.toml
|
||||
* Change the revision
|
||||
* Run `cargo update -p ocicrypt-rs`
|
||||
The release process mainly follows from this dependency graph.
|
||||
|
||||
2. - [ ] Update image-rs to use the latest commit from attestation-agent
|
||||
```mermaid
|
||||
flowchart LR
|
||||
Trustee --> Versions.yaml
|
||||
Guest-Components --> Versions.yaml
|
||||
Kata --> kustomization.yaml
|
||||
Guest-Components .-> Client-tool
|
||||
Guest-Components --> enclave-agent
|
||||
enclave-cc --> kustomization.yaml
|
||||
Guest-Components --> versions.yaml
|
||||
Trustee --> versions.yaml
|
||||
Kata --> versions.yaml
|
||||
|
||||
* https://github.com/confidential-containers/image-rs/blob/main/Cargo.toml
|
||||
* Change the revision
|
||||
* Run `cargo update -p attestation_agent`
|
||||
subgraph Kata
|
||||
Versions.yaml
|
||||
end
|
||||
subgraph Guest-Components
|
||||
end
|
||||
subgraph Trustee
|
||||
Client-tool
|
||||
end
|
||||
subgraph enclave-cc
|
||||
enclave-agent
|
||||
end
|
||||
subgraph Operator
|
||||
kustomization.yaml
|
||||
reqs-deploy
|
||||
end
|
||||
subgraph cloud-api-adaptor
|
||||
versions.yaml
|
||||
end
|
||||
```
|
||||
|
||||
3. - [ ] Update Enclave CC to use the latest commit from image-rs
|
||||
Starting with v0.9.0 the release process no longer involves centralized dependency management.
|
||||
In other words, when doing a CoCo release, we don't push the most recent versions of the subprojects
|
||||
into Kata and enclave-cc. Instead, dependencies should be updated during the normal process of development.
|
||||
Releases of most subprojects are now decoupled from releases of the CoCo project.
|
||||
|
||||
* https://github.com/confidential-containers/enclave-cc/blob/main/src/enclave-agent/Cargo.toml
|
||||
* Change the revision
|
||||
* Run `cargo update -p image-rs`
|
||||
Note that you can point to your own fork here, so you don't actually do changes in the other projects
|
||||
before making sure this step works as expected.
|
||||
## The Steps
|
||||
|
||||
4. - [ ] Update Kata Containers to use the latest commit from image-rs, attestation-agent and td-shim
|
||||
### Determine release builds
|
||||
|
||||
* image-rs
|
||||
* https://github.com/kata-containers/kata-containers/blob/CCv0/src/agent/Cargo.toml
|
||||
* Change the revision
|
||||
* Run `cargo update -p image-rs`
|
||||
Note that you can point to your own fork here, so you don't actually do changes in the other projects
|
||||
before making sure this step works as expected.
|
||||
* attestation-agent and td-shim
|
||||
* https://github.com/kata-containers/kata-containers/blob/CCv0/versions.yaml
|
||||
* Change the version
|
||||
Identify/create the bundles that we will release for Kata and enclave-cc.
|
||||
|
||||
5. - [ ] Wait for kata-runtime-payload-ci to be successfully built
|
||||
* After the previous PR is merged wait for the kata-runtime-payload-ci (https://github.com/kata-containers/kata-containers/actions/workflows/cc-payload-after-push.yaml) has completed, so the latest kata-runtime-payload-ci contains the changes
|
||||
- [ ] 1. :eyes: **Create enclave-cc release**
|
||||
|
||||
6. - [ ] Check if there are new changes in the pre install payload script
|
||||
Enclave-cc does not have regular releases apart from CoCo, so we need to make one.
|
||||
Make sure that the CI [is green](https://github.com/confidential-containers/operator/actions/workflows/enclave-cc-cicd.yaml) and then use the Github release tool to create a tag and release.
|
||||
This should create a bundle [here](https://quay.io/repository/confidential-containers/runtime-payload?tab=tags).
|
||||
|
||||
* https://github.com/confidential-containers/operator/tree/main/install/pre-install-payload
|
||||
* The last commit there must match what's in the following files as preInstall / postUninstall image
|
||||
* Enclave CC: https://github.com/confidential-containers/operator/blob/main/config/samples/enclave-cc/base/ccruntime-enclave-cc.yaml
|
||||
* Kata Containers:
|
||||
Note that for Kata Containers, we're looking for the newTag, below the quay.io/confidential-containers/container-engine-for-cc-payload image
|
||||
* default: https://github.com/confidential-containers/operator/blob/main/config/samples/ccruntime/default/kustomization.yaml
|
||||
- [ ] 2. :eyes: **Find Kata release version**
|
||||
|
||||
7. - [ ] Ensure the Operator is using the latest CI builds and that the Operator tests are passsing
|
||||
The release will be based on an existing Kata containers bundle.
|
||||
You should use a release of Kata containers.
|
||||
Release bundles can be found [here](https://quay.io/repository/kata-containers/kata-deploy?tab=tags).
|
||||
There is also a bundle built for [each commit](https://quay.io/repository/kata-containers/kata-deploy-ci?tab=tags).
|
||||
If you absolutely cannot use a Kata release,
|
||||
you can consider releasing one of these bundles.
|
||||
|
||||
### Test Release with Operator
|
||||
|
||||
- [ ] 3. :eyes: **Check operator pre-installation and open PR if needed**
|
||||
|
||||
The operator uses a pre-install container to setup the node.
|
||||
Check that the container matches the dependencies used in Kata
|
||||
and that the operator pulls the most recent version of the container.
|
||||
|
||||
* Check that the version of the `nydus-snapshotter` used by Kata matches the one used by the operator
|
||||
* Compare `nydus-snapshotter` version in Kata [versions.yaml](https://github.com/kata-containers/kata-containers/blob/main/versions.yaml#L325) with the [Makefile](https://github.com/confidential-containers/operator/blob/main/install/pre-install-payload/Makefile#L4) for the operator pre-install container.
|
||||
* **If they do not match, stop and open a PR now. In the PR, update the operator's Makefile to match the version used in kata. After the PR is merged, continue.**
|
||||
|
||||
- [ ] 4. :wrench: **Open a PR to the operator to update the release artifacts**
|
||||
|
||||
Update the operator to use the payloads identified in steps 1, 2, and 3.
|
||||
|
||||
Make sure that the operator pulls the most recent version of the pre-install container
|
||||
* Find the last commit in the [pre-install directory](https://github.com/confidential-containers/operator/tree/main/install/pre-install-payload)
|
||||
* As a sanity check, the sha hash of the last commit in that pre-install directory will correspond to a pre-install image in quay, i.e. a reqs-payload image [here](quay.io/confidential-containers/reqs-payload).
|
||||
* Make sure that the commit matches the preInstall / postUninstall image specified for [enclave-cc CRD](https://github.com/confidential-containers/operator/blob/main/config/samples/enclave-cc/base/ccruntime-enclave-cc.yaml) and [ccruntime CRD](https://github.com/confidential-containers/operator/blob/main/config/samples/ccruntime/default/kustomization.yaml)
|
||||
* If these do not match (for instance if you changed the snapshotter in step 3), update the operator so that they do match.
|
||||
|
||||
There are a number of places where the payloads are referenced. Make sure to update all of the following to the tag matching the latest commit hash from steps 1 and 2:
|
||||
* Enclave CC:
|
||||
* SIM: https://github.com/confidential-containers/operator/blob/main/config/samples/enclave-cc/sim/kustomization.yaml
|
||||
* HW: https://github.com/confidential-containers/operator/blob/main/config/samples/enclave-cc/base/ccruntime-enclave-cc.yaml
|
||||
* Note that we need the quay.io/confidential-containers/runtime-payload-ci registry and enclave-cc-{SIM,HW}-latest tags
|
||||
* [sim](https://github.com/confidential-containers/operator/blob/main/config/samples/enclave-cc/sim/kustomization.yaml)
|
||||
* [hw](https://github.com/confidential-containers/operator/blob/main/config/samples/enclave-cc/hw/kustomization.yaml)
|
||||
* [base](https://github.com/confidential-containers/operator/blob/main/config/samples/enclave-cc/base/ccruntime-enclave-cc.yaml)
|
||||
* Kata Containers:
|
||||
* default: https://github.com/confidential-containers/operator/blob/main/config/samples/ccruntime/default/kustomization.yaml
|
||||
* peer-pods: https://github.com/confidential-containers/operator/blob/main/config/samples/ccruntime/peer-pods/kustomization.yaml
|
||||
* [default](https://github.com/confidential-containers/operator/blob/main/config/samples/ccruntime/default/kustomization.yaml)
|
||||
* [s390x](https://github.com/confidential-containers/operator/blob/main/config/samples/ccruntime/s390x/kustomization.yaml)
|
||||
* [peer-pods](https://github.com/confidential-containers/operator/blob/main/config/samples/ccruntime/peer-pods/kustomization.yaml)
|
||||
Note that we need the quay.io/confidential-containers/runtime-payload-ci registry and kata-containers-latest tag
|
||||
|
||||
8. - [ ] Update peer-pods with latest commits of kata-containers and attestation-agent and test it, following the [release candidate testing process](https://github.com/confidential-containers/cloud-api-adaptor/blob/main/docs/Release-Process.md#release-candidate-testing)
|
||||
|
||||
9. - [ ] Cut an ocicrypt-rs v<TARGET_RELEASE> release, if changes happened in the project
|
||||
**Also, update the [operator version](https://github.com/confidential-containers/operator/blob/main/config/release/kustomization.yaml#L7)**
|
||||
|
||||
10. - [ ] Cut an attestation-agent v<TARGET_RELEASE>, if changes happened in the project
|
||||
### Final Touches
|
||||
|
||||
11. - [ ] Cut an attestation-service v<TARGET_RELEASE> and make images for AS and RVPS, if changes happened in the project.
|
||||
- [ ] 5. :trophy: **Cut an operator release using the GitHub release tool**
|
||||
|
||||
* https://github.com/confidential-containers/attestation-service
|
||||
* Cut a release (AS/RVPS images will be automatically built triggered by release)
|
||||
- [ ] 6. :green_book: **Make sure to update the [release notes](https://github.com/confidential-containers/confidential-containers/tree/main/releases) and tag/release the confidential-containers repo using the GitHub release tool.**
|
||||
|
||||
12. - [ ] Update kbs to use the latest commit from attestation-service, cut a release and make image
|
||||
- [ ] 7. :hammer: **Poke Wainer Moschetta (@wainersm) to update the release to the OperatorHub. Find the documented flow [here](https://github.com/confidential-containers/operator/blob/main/docs/OPERATOR_HUB.md).**
|
||||
|
||||
* https://github.com/confidential-containers/kbs/blob/main/src/api_server/Cargo.toml
|
||||
* Change the revision for the following crates (both use `v<TARGET_RELEASE>`)
|
||||
* `as-types`
|
||||
* `attestation-service`
|
||||
* Cut a release (kbs image will be automatically built triggered by release)
|
||||
### Post-release
|
||||
|
||||
13. - [ ] Cut an image-rs v<TARGET_RELEASE> release, using the latest release of:
|
||||
|
||||
* ocicrypt-rs (redo step 1, but now using v<TARGET_RELEASE>)
|
||||
* attestation-agent (redo step 2, but now using v<TARGET_RELEASE>)
|
||||
|
||||
14. - [ ] Cut a td-shim v<TARGET_RELEASE> release, if changes happened in the project
|
||||
|
||||
15. - [ ] Update Enclave CC to use the released version of image-rs
|
||||
|
||||
* redo step 3, but now using v<TARGET_RELEASE>
|
||||
|
||||
16. - [ ] Update Kata Containers to the latest released version of:
|
||||
|
||||
* image-rs (redo step 4, but now using the v<TARGET_RELEASE>)
|
||||
* attestation-agent (redo step 5, but now using the v<TARGET_RELEASE>)
|
||||
* td-shim (redo step 6, but now using the v<TARGET_RELEASE>)
|
||||
|
||||
17. - [ ] Update the operator to use the images generated from the latest commit of both Kata Containers and Enclave CC
|
||||
|
||||
* redo step 8, but now targetting the latest payload image generated for Kata Containers and Enclave CC
|
||||
|
||||
19. - [ ] Make sure all the operator tests are passing
|
||||
|
||||
19. - [ ] Cut an Enclave CC release
|
||||
|
||||
20. - [ ] Add a new Kata Containers tag
|
||||
|
||||
|
||||
21. - [ ] Wait for release kata-runtime-payload to be successfully built
|
||||
* After the Kata tag is created wait for (https://github.com/kata-containers/kata-containers/actions/workflows/cc-payload.yaml) to be successfully completed, so the latest commit kata-runtime-payload for the release is created
|
||||
|
||||
22. - [ ] Update peer pods to use the release versions and then cut a release following the [documented flow](https://github.com/confidential-containers/cloud-api-adaptor/blob/main/docs/Release-Process.md#cutting-releases)
|
||||
|
||||
## Release
|
||||
|
||||
|
||||
23. - [ ] Update the operator to use the release tags coming from Enclave CC and Kata Containers
|
||||
|
||||
* redo step 8, but now targeting the latest release of the payload image generated for Kata Containers eand Enclave CC
|
||||
|
||||
24. - [ ] Update the Operator version
|
||||
|
||||
* https://github.com/confidential-containers/operator/blob/main/config/release/kustomization.yaml#L7
|
||||
|
||||
25. - [ ] Cut an operator release
|
||||
|
||||
26. - [ ] Make sure to update the release notes
|
||||
|
||||
* https://github.com/confidential-containers/documentation/tree/main/releases/v<TARGET_RELEASE>.md
|
||||
|
||||
27. - [ ] Poke Wainer Moschetta (@wainersm) to update the release to the OperatorHub
|
||||
- [ ] 8. :wrench: **Open a PR to the operator to go back to latest payloads after release**
|
||||
After the release, the operator's payloads need to go back to what they were (e.g. using "latest" instead of a specific commit sha). As an example, step 4 for the v0.9.0-alpha0 release applied [these changes](https://github.com/confidential-containers/operator/pull/368/files), and for this step, you should use `git revert` to undo such changes you made during the release.
|
||||
|
28
.github/workflows/links.yml
vendored
Normal file
28
.github/workflows/links.yml
vendored
Normal file
@@ -0,0 +1,28 @@
|
||||
name: check links
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
pull_request:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
checklinks:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: Restore lychee cache
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: .lycheecache
|
||||
key: cache-lychee-${{ github.sha }}
|
||||
restore-keys: cache-lychee-
|
||||
|
||||
- name: Check links
|
||||
uses: lycheeverse/lychee-action@v1
|
||||
with:
|
||||
args: "--cache --max-cache-age 1d ."
|
||||
fail: true
|
780
CONTRIBUTING.md
780
CONTRIBUTING.md
@@ -1,52 +1,122 @@
|
||||
# Contribute to the Confidential Containers project
|
||||
# Contributor Guide
|
||||
|
||||
The Confidential Containers project is an open source project licensed under the
|
||||
[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
|
||||
So you want to contribute to Confidential Containers?
|
||||
This guide will get you up to speed on the mechanics of the project
|
||||
and offer tips about how to work with the community and make great
|
||||
contributions.
|
||||
|
||||
It comprises a number of repositories under the [GitHub Confidential
|
||||
Containers organisation](https://github.com/confidential-containers). Unless
|
||||
explicitly stated otherwise, all the Confidential Containers repositories follow the
|
||||
process documented here.
|
||||
First off, Confidential Containers (CoCo) is an open source project.
|
||||
You probably already knew that, but it's good to be clear
|
||||
that we welcome contributions, involvement, and insight from everyone.
|
||||
Just make sure to follow the [code of conduct](CODE_OF_CONDUCT.md).
|
||||
|
||||
## Code of Conduct
|
||||
CoCo is licensed with [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
|
||||
|
||||
All contributors must agree to the project [code of conduct](CODE_OF_CONDUCT.md).
|
||||
This guide won't cover the architecture of the project, but you'll notice
|
||||
that there are many different repositories under the [CoCo
|
||||
organization](https://github.com/confidential-containers).
|
||||
A CoCo deployment integrates many different components.
|
||||
Fortunately the process for contributing to each of these subprojects
|
||||
is largely the same.
|
||||
There is one major exception. Most CoCo deployments leverage [Kata Containers](https://github.com/kata-containers),
|
||||
which is an existing open source project. Kata has its own [Contributor Guide](https://github.com/kata-containers/community/blob/main/CONTRIBUTING.md)
|
||||
that you should take a look at.
|
||||
You can contribute to CoCo by contributing to Kata, but this guide is focused on
|
||||
contributions made to repositories in the CoCo organization.
|
||||
|
||||
## Pull requests
|
||||
## Connecting with the Community
|
||||
|
||||
All the repositories accept contributions via [GitHub Pull requests (PR)](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests).
|
||||
Submit PRs by following the [GitHub workflow](#github-workflow).
|
||||
You might already know exactly what you want to contribute and how.
|
||||
If not, if would be useful to interact with existing developers.
|
||||
There are several easy ways to do this.
|
||||
|
||||
## GitHub basic setup
|
||||
### Slack Channel
|
||||
|
||||
To get started, complete the prerequisites below.
|
||||
The best place to interact with the CoCo community is the
|
||||
`#confidential-containers` channel in the [CNCF Slack workspace](https://slack.cncf.io/).
|
||||
This is a great place to ask any questions about the project
|
||||
and to float ideas for future development.
|
||||
|
||||
### Prerequisites
|
||||
### Community Meeting
|
||||
|
||||
- Review [Contributor roles](#contributor-roles) that require special Git
|
||||
configuration.
|
||||
CoCo also has a weekly community meeting on Thursdays.
|
||||
See [the agenda](https://docs.google.com/document/d/1E3GLCzNgrcigUlgWAZYlgqNTdVwiMwCRTJ0QnJhLZGA/)
|
||||
for more information.
|
||||
The community meeting usually has a packed agenda, but there is always time
|
||||
for a few basic questions.
|
||||
|
||||
- [Set up Git](https://help.github.com/en/github/getting-started-with-github/set-up-git).
|
||||
### GitHub Issue
|
||||
|
||||
> **Note:** The email address you specify must match the email address you
|
||||
> use to sign-off commits.
|
||||
You can also open issues in GitHub.
|
||||
Try to open your issue on the repository that is most closely related
|
||||
to your question.
|
||||
If you aren't sure which repository is most relevant, you can open an issue
|
||||
on this repository.
|
||||
If you're creating an issue that you plan to resolve, consider noting this in
|
||||
a comment so other developers know that someone is working on the problem.
|
||||
|
||||
- [Fork and Clone](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the relevant repository at the
|
||||
[Confidential Containers Project](https://github.com/confidential-containers).
|
||||
## Making Contributions
|
||||
|
||||
Example: Your local clone should show `your-github-username`, as follows.
|
||||
`https://github.com/${your-github-username}/community`.
|
||||
The mechanics of making a contribution are straightforward.
|
||||
We follow a typical [GitHub contribution flow](https://guides.github.com/introduction/flow/).
|
||||
All contributions should be made as GitHub pull requests.
|
||||
Make sure your PR includes a Developer Certificate of Origin (DCO)
|
||||
and follow any existing stylistic or organizational conventions.
|
||||
These requirements are explained in more detail below.
|
||||
|
||||
### Contributor roles
|
||||
Some contributions are simpler than others.
|
||||
If you are new to the community it could be good to start with
|
||||
a few simple contributions to get used to the process.
|
||||
Larger contributions, especially ones that span multiple subprojects,
|
||||
or have implications on the trust model or project architecture,
|
||||
will usually require more discussion and review.
|
||||
Nonetheless, CoCo has a track record of [responding to PRs quickly](https://confidentialcontainers.devstats.cncf.io/d/10/pr-time-to-engagement)
|
||||
and [merging PRs quickly](https://confidentialcontainers.devstats.cncf.io/d/16/opened-to-merged).
|
||||
|
||||
If you contribute code change in Rust or Go, please adhere to the following style guides.
|
||||
If you are preparing a large contribution, it is wise to share your idea
|
||||
with the community as early as possible. Consider making an `RFC` issue
|
||||
that explains the changes. You might also try to break large contributions
|
||||
into smaller steps.
|
||||
|
||||
### Go coding style
|
||||
### Making a Pull Request
|
||||
|
||||
* Review [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments) to avoid common Go errors.
|
||||
* Use `gofmt` to fix any mechanical style issues.
|
||||
If you aren't familiar with Git or the GitHub PR workflow, take a look at [this section](https://github.com/kata-containers/community/blob/main/CONTRIBUTING.md#github-workflow)
|
||||
of the Kata Containers contributor guide.
|
||||
We have a few firm formatting requirements that you must follow,
|
||||
but in general if you are thoughtful about your work and responsive to review,
|
||||
you shouldn't have any issues getting your PRs merged.
|
||||
The requirements that we do have are there to make everyone's life a little easier.
|
||||
Don't worry if you forget to follow one of them at first.
|
||||
You can always update your PR if necessary.
|
||||
If you have any ideas for how we can improve our processes,
|
||||
please suggest them to the community or make PR to this document.
|
||||
|
||||
### Rust coding style
|
||||
#### Certificate of Origin
|
||||
|
||||
Every PR in every subproject is required to include a DCO.
|
||||
This is strictly enforced by the CI.
|
||||
Fortunately, it's easy to comply with this requirement.
|
||||
At the end of the commit message for each of your commits add something like
|
||||
```
|
||||
Signed-off-by: Alex Ample <al@example.com>
|
||||
```
|
||||
You can add additional tags to credit other developers who worked on a commit
|
||||
or helped with it.
|
||||
See [here](https://ltsi.linuxfoundation.org/software/signed-off-process/)
|
||||
for more information.
|
||||
|
||||
|
||||
#### Coding Style
|
||||
|
||||
Please follow whatever stylistic and organizational conventions have been
|
||||
established in the subproject that you are contributing to.
|
||||
|
||||
Most CoCo subprojects use Rust. When using Rust, it is a good idea to run `rustfmt` and `clippy`
|
||||
before submitting a PR.
|
||||
Most subprojects will automatically run these tools via a workflow,
|
||||
but you can also run the tools locally.
|
||||
In most cases your code will not be accepted if it does not pass these tests.
|
||||
Projects might have additional conventions that are not captured by these tools.
|
||||
|
||||
* Use `rustfmt` to fix any mechanical style issues. Rustfmt uses a style which conforms to the
|
||||
[Rust Style Guide](https://doc.rust-lang.org/nightly/style-guide/).
|
||||
@@ -58,611 +128,67 @@ You can install the above tools as follows.
|
||||
$ rustup component add rustfmt clippy
|
||||
```
|
||||
|
||||
### Certificate of Origin
|
||||
|
||||
In order to get a clear contribution chain of trust we use the [signed-off-by
|
||||
language](https://ltsi.linuxfoundation.org/software/signed-off-process/)
|
||||
used by the Linux kernel project.
|
||||
#### Commit Format
|
||||
|
||||
## GitHub best practices
|
||||
Along with code your contribution will include commit messages.
|
||||
|
||||
### Submit issues before PRs
|
||||
|
||||
Raise a GitHub issue **before** starting work on a PR.
|
||||
|
||||
* Our process requires an issue to be associated with every PR (see [patch format](#patch-format))
|
||||
|
||||
* If you are a new contributor, create an issue and add a comment stating
|
||||
that you intend to work on the issue. This notifies our team of the work you
|
||||
plan to do.
|
||||
|
||||
### Issue tracking
|
||||
|
||||
To report a bug that is not already documented, please open a GitHub issue for the repository in question.
|
||||
|
||||
If it is unclear which repository to raise your query against, first try to
|
||||
get in [contact](#contact) with us. If in doubt, raise the issue
|
||||
[here](https://github.com/confidential-containers/community/issues/new) and we will
|
||||
help you to handle the query by routing it to the correct area for resolution.
|
||||
|
||||
### Closing issues
|
||||
|
||||
Our tooling requires adding a `Fixes` comment to at least one commit in the PR, which triggers GitHub to automatically close the issue once the PR is merged:
|
||||
As mentioned, commit messages are required to have a `Signed-off-by` footer.
|
||||
Commit messages should not be empty.
|
||||
Even if the commit is self-explanatory to you, include a short description of
|
||||
what it does.
|
||||
This helps reviewers and future developers.
|
||||
|
||||
The title of the commit should start with a subsystem. For example,
|
||||
```
|
||||
pod: Remove token from Cmd structure
|
||||
|
||||
The token and pid data will be hold by the new Process structure and
|
||||
they are related to a container.
|
||||
|
||||
Fixes #123
|
||||
|
||||
Signed-off-by: Sebastien Boeuf <sebastien.boeuf@intel.com>
|
||||
docs: update contributor guide
|
||||
```
|
||||
|
||||
The issue is automatically closed by GitHub when the
|
||||
[commit message](https://help.github.com/articles/closing-issues-via-commit-messages/) is parsed.
|
||||
|
||||
## GitHub workflow
|
||||
|
||||
Confidential Containers employs certain augmentations to a
|
||||
[standard GitHub workflow](https://guides.github.com/introduction/flow/).
|
||||
In this section, we explain these augmentations in more detail. Follow these guidelines when contributing to Confidential Containers repositories, except where noted below.
|
||||
|
||||
* Complete the [GitHub basic setup](#github-basic-setup) above before continuing.
|
||||
|
||||
* Ensure each PR only covers one topic. If you mix up different items in
|
||||
your patches or PR, they will likely need to be reworked.
|
||||
|
||||
* Follow a [topic branch method](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-branches) for development.
|
||||
|
||||
* Follow carefully the [patch format](#patch-format) for PRs.
|
||||
|
||||
* Apply the appropriate GitHub labels to your PR. This
|
||||
is particularly relevant to maintain [Stable branch backports](#stable-branch-backports).
|
||||
See also [GitHub labels and keywords that block PRs](#github-labels-and-keywords-that-block-prs)
|
||||
|
||||
> **Note:** External contributors should use keywords, explained in the
|
||||
> link above. Labels may not be visible to external contributors.
|
||||
|
||||
* [Rebase](https://help.github.com/en/github/using-git/about-git-rebase)
|
||||
commits on your branch and `force push` after each cycle of feedback.
|
||||
|
||||
### Configure your environment
|
||||
|
||||
Some [Confidential Containers repositories](https://github.com/confidential-containers)
|
||||
contain code written in the [Go language (golang)](https://go.dev/). Follow the [setup guide](https://go.dev/doc/install)
|
||||
to install the latest Go command.
|
||||
|
||||
#### Fork and clone
|
||||
|
||||
In this example, we configure a Git environment to contribute to this very
|
||||
`confidential-containers` repo. We create a sample branch, incorporate reviewer feedback, and rebase our commits.
|
||||
|
||||
1. Fork the [upstream repository](https://help.github.com/articles/cloning-a-repository):
|
||||
|
||||
1. [Clone your forked copy of the upstream repository](https://help.github.com/articles/cloning-a-repository):
|
||||
|
||||
1. While on your *forked copy*, select the green button `Clone or download`
|
||||
and copy the URL.
|
||||
|
||||
1. Run the commands below and **paste the copied URL** (previous step),
|
||||
so your real GitHub username replaces `your-github-username` below.
|
||||
|
||||
```sh
|
||||
$ git clone https://github.com/{your-github-username}/confidential-containers
|
||||
$ cd confidential-containers
|
||||
```
|
||||
|
||||
> **Note:** Cloning a forked repository automatically gives a remote `origin`.
|
||||
|
||||
#### Configure the upstream remote
|
||||
|
||||
> **Note:** You can also use the GitHub web interface to synchronize your `origin` with the upstream repository.
|
||||
|
||||
Next, add the remote `upstream`. Configuring this remote allows you to
|
||||
synchronize your forked copy, `origin`, with the `upstream`. The
|
||||
`upstream` URL varies by repository. We use the `upstream` from this repository for this example.
|
||||
|
||||
1. Ensure you are within your local clone of the `confidential-containers` repository.
|
||||
|
||||
1. Set the remote `upstream` as follows.
|
||||
|
||||
```sh
|
||||
$ git remote add upstream https://github.com/confidential-containers/community
|
||||
```
|
||||
|
||||
1. Run `git remote -v`. Your remotes should appear similar to these:
|
||||
|
||||
```
|
||||
origin https://github.com/your-github-username/community.git (fetch)
|
||||
origin https://github.com/your-github-username/community.git (push)
|
||||
upstream https://github.com/confidential-containers/community (fetch)
|
||||
upstream https://github.com/confidential-containers/community (push)
|
||||
```
|
||||
|
||||
For more details, see how to [set up a git remote](https://help.github.com/articles/configuring-a-remote-for-a-fork).
|
||||
|
||||
#### Create a topic branch
|
||||
|
||||
1. Create a new "topic branch" to do your work on:
|
||||
|
||||
```sh
|
||||
$ git checkout -b fix-contrib-bugs
|
||||
```
|
||||
|
||||
> **Warning:** *Never* make changes directly to the `main` branch
|
||||
> -- *always* create a new "topic branch" for PR work.
|
||||
|
||||
1. Make some editorial changes. In this example, we modify the file that
|
||||
you are reading.
|
||||
|
||||
```sh
|
||||
$ $EDITOR CONTRIBUTING.md
|
||||
```
|
||||
|
||||
> **Note:** If editing in Windows make sure that all documents end with LF
|
||||
> and not CRLF. The CI system will fail if carriage returns are in the
|
||||
> document. Many editors support the ability to change this. There is a
|
||||
> tool called dos2unix available on Git Bash for Windows and also available
|
||||
> on Linux systems that can convert files to LF endings. See the
|
||||
> [Configuring Git to handle line endings](https://docs.github.com/en/github/getting-started-with-github/getting-started-with-git/configuring-git-to-handle-line-endings)
|
||||
> guide for more details on how to configure `git` to automatically insert
|
||||
> the correct line endings.
|
||||
|
||||
1. Commit your changes to the current (`fix-contrib-bugs`) branch. Assure
|
||||
you use the correct [patch format](#patch-format):
|
||||
|
||||
```sh
|
||||
$ git commit -as
|
||||
```
|
||||
|
||||
1. Push your local `fix-contrib-bugs` branch to your remote fork:
|
||||
|
||||
```sh
|
||||
$ git push -u origin fix-contrib-bugs
|
||||
```
|
||||
|
||||
> **Note:** The `-u` option tells `git` to "link" your local clone with
|
||||
> your remote fork so that it knows from now on that the local repository
|
||||
> and the remote fork refer to "the same" upstream repository. Strictly
|
||||
> speaking, this option is only required the first time you call `git push`
|
||||
> for a new clone.
|
||||
|
||||
1. Create the PR:
|
||||
|
||||
- Browse to https://github.com/confidential-containers/community.
|
||||
- Click the `Compare & pull request` button that appears.
|
||||
- Click the `Create pull request` button.
|
||||
|
||||
> **Note:** You do not need to change any of the defaults on this page.
|
||||
|
||||
#### Update your PR based on review comments
|
||||
|
||||
Suppose you received some reviewer feedback that asked you to make some
|
||||
changes to your PR. You updated your local branch and committed those
|
||||
review changes by creating three commits. There are now four commits in your
|
||||
local branch: the original commit you created for the PR and three other
|
||||
commits you created to apply the review changes to your branch. Your branch
|
||||
now looks something like this:
|
||||
|
||||
```sh
|
||||
$ git log main.. --oneline --decorate=no
|
||||
4928d57 docs: Fix typos and fold long lines
|
||||
829c6c8 apply review feedback changes
|
||||
7c9b1b2 remove blank lines
|
||||
60e2b2b doh - missed one
|
||||
```
|
||||
|
||||
> **Note:** The `git log` command compares your current branch
|
||||
> (`fix-contrib-bugs`) with the `main` branch and lists all the commits,
|
||||
> one per line.
|
||||
|
||||
#### Git rebase if multiple commits
|
||||
|
||||
Since all four commits are related to *the same change*, it makes sense to
|
||||
combine all four commits into a *single commit* on your PR. You need to
|
||||
[git rebase](https://help.github.com/github/using-git/about-git-rebase)
|
||||
multiple commits on your branch. Follow these steps.
|
||||
|
||||
1. Update the `main` branch in your local copy of the upstream
|
||||
repository:
|
||||
|
||||
```sh
|
||||
$ git checkout main
|
||||
$ git pull --rebase upstream main
|
||||
```
|
||||
|
||||
The previous command downloads all the latest changes from the upstream
|
||||
repository and adds them to your *local copy*.
|
||||
|
||||
In case you didn't configure an upstream origin but want to sync via the GitHub web interface,
|
||||
sync your `main` branch there and execute:
|
||||
|
||||
```sh
|
||||
$ git checkout main
|
||||
$ git pull
|
||||
```
|
||||
|
||||
1. Now, switch back to your PR branch:
|
||||
|
||||
```sh
|
||||
$ git checkout fix-contrib-bugs
|
||||
```
|
||||
|
||||
1. Rebase your changes against the `main` branch.
|
||||
|
||||
```sh
|
||||
$ git rebase -i main
|
||||
```
|
||||
|
||||
Example output:
|
||||
|
||||
```sh
|
||||
pick 2e335ac docs: Fix typos and fold long lines
|
||||
pick 6d6deb0 apply review feedback changes
|
||||
pick 23bc01d remove blank lines
|
||||
pick 3a4ba3f doh - missed one
|
||||
```
|
||||
|
||||
1. In your editor, read the comments at the bottom of the screen.
|
||||
Do not modify the first line, `pick 2e335ac docs: Fix typos ...`. Instead, revise `pick` to `fixup` at the start of all following lines.
|
||||
|
||||
Example output:
|
||||
|
||||
```sh
|
||||
pick 2e335ac docs: Fix typos and fold long lines
|
||||
fixup 6d6deb0 apply review feedback changes
|
||||
fixup 23bc01d remove blank lines
|
||||
fixup 3a4ba3f doh - missed one
|
||||
```
|
||||
|
||||
Once this operation completes, the four
|
||||
commits will have been converted into a single new commit. Check this by
|
||||
running the `git log` command again:
|
||||
|
||||
```sh
|
||||
$ git log main.. --oneline --decorate=no
|
||||
3ea3aef docs: Fix typos and fold long lines
|
||||
```
|
||||
|
||||
1. Force push your updated local `fix-contrib-bugs` branch to `origin`
|
||||
remote:
|
||||
|
||||
```sh
|
||||
$ git push --force-with-lease origin fix-contrib-bugs
|
||||
```
|
||||
|
||||
> **Note:** Not only does this command upload your changes to your fork, it
|
||||
> also includes the *latest upstream changes* to your fork since you ran
|
||||
> `git pull --rebase upstream main` on the main branch and then merged
|
||||
> those changes into your PR branch. This ensures your fork is now "up to
|
||||
> date" with the upstream repository. The `--force-with-lease` option is a "force push". Since
|
||||
> you created a new commit using `git rebase`, you must "overwrite" the old
|
||||
> copy of your branch in your fork on GitHub. Be careful with force pushes,
|
||||
> it is one of the few things that can cause you to lose previous work in git.
|
||||
|
||||
Your PR is now updated on GitHub. To ensure team members are aware of this,
|
||||
leave a message on the PR stating something like, "Review feedback applied".
|
||||
This notification allows the team to once again review your PR more quickly.
|
||||
|
||||
### GitHub labels and keywords that block PRs
|
||||
|
||||
Confidential Containers CI systems have two methods that allow marking
|
||||
PRs to prevent them being merged. This practice is often used during
|
||||
development. The two methods are: 1) Use
|
||||
[GitHub labels](https://help.github.com/articles/about-labels/)
|
||||
or; 2) Use keywords in the PR subject line. The keywords can appear anywhere
|
||||
in the subject line.
|
||||
|
||||
The following table summarises some common scenarios and appropriate use
|
||||
of labels or keywords:
|
||||
|
||||
| Scenario | GitHub label | PR description contains |
|
||||
| -------------------------------------------------------------------------------- | -------------------- | ----------------------- |
|
||||
| PR created "as an idea" and feedback sought | `rfc` | RFC |
|
||||
| PR incomplete - needs more work or rework | `do-not-merge` `wip` | WIP |
|
||||
| PR should not be merged (has all required "acks", but needs more reviewer input) | `do-not-merge` | |
|
||||
| PR is a "work In progress", raised to get early feedback | `wip` | WIP |
|
||||
| PR is complete but depends on another so should not be merged (yet) | `do-not-merge` | |
|
||||
|
||||
If any of the values in the table above are set on a PR, it will be
|
||||
automatically blocked from merging.
|
||||
|
||||
> **Note:** Often during discussions, the abbreviated and full terms are
|
||||
> used interchangeably. For instance, often `DNM` is used in discussions as
|
||||
> shorthand for `do-not-merge`. The CI systems only recognise the above
|
||||
> phrases as shown.
|
||||
|
||||
## Use static checks for validation
|
||||
|
||||
* Confidential Containers utilizes [Continuous Integration (CI)](#continuous-integration) to automatically check every PR.
|
||||
|
||||
* We strongly encourage you to run the same CI tests on individual PRs, using [static checks](https://github.com/confidential-containers/tests/blob/main/.ci/static-checks.sh)
|
||||
|
||||
In repositories where a `Makefile` is present, you can execute
|
||||
static checks for testing and development. To do so, invoke the `make check` and `make test` rules, after developer mode is enabled.
|
||||
|
||||
```sh
|
||||
$ export KATA_DEV_MODE=true
|
||||
$ make check
|
||||
$ make test
|
||||
```
|
||||
Running these checks should result in **no errors**. If errors are reported, fix them before submitting your PR.
|
||||
|
||||
To replicate the static checks performed by the CI system:
|
||||
|
||||
- [x] Ensure you have a "clean" source tree, as the checks cover all files
|
||||
present. Checks might fail if you have extra files or your files are out of date in your tree.
|
||||
|
||||
- [x] Ensure [`golangci-lint`](https://github.com/golangci/golangci-lint) is
|
||||
current or has not been previously installed (the static check scripts will
|
||||
install it if necessary). Changing the linters can produce spurious errors that do not fail inside
|
||||
the CI systems.
|
||||
|
||||
### Fix failed static checks after submitting PRs
|
||||
|
||||
Some submitted PRs fail to pass static checks. After such a PR fails,
|
||||
view its build logs to determine the cause of failure.
|
||||
|
||||
1. At the bottom of the PR, if a message appears, "Some checks were not
|
||||
successful," select "Details", as shown below.
|
||||
|
||||

|
||||
|
||||
1. Upon entering the Travis CI* web page, select the first number that
|
||||
appears below "Build jobs."
|
||||
|
||||
1. Scroll to the bottom of the build log and view the `ERROR` message(s).
|
||||
In the example below, the `ERROR` reads: `... no
|
||||
signed-off-by specified`. This is a requirement. To fix, use the signed-off-by method while pushing a commit. See [Patch format](
|
||||
#patch-format) for more details.
|
||||
|
||||

|
||||
|
||||
|
||||
## Porting
|
||||
|
||||
Porting applies a patch set to an older ("backport") or a newer
|
||||
("forward-port") branch or repository.
|
||||
|
||||
Backporting is necessary to ensure that older -- but still maintained --
|
||||
releases benefit from bug fixes already applied to newer releases.
|
||||
|
||||
Forward porting is necessary where there are multiple development streams and
|
||||
bug fixes or new features have been applied to the older stream, but not the
|
||||
newer one.
|
||||
|
||||
> **Note:**
|
||||
>
|
||||
> Stable branches are considered maintenance branches, not development
|
||||
> branches. Bug fixes must land in a newer development branch before landing
|
||||
> in a stable branch to ensure the changes have been tested thoroughly before
|
||||
> being applied to a stable release (maintenance) branch.
|
||||
|
||||
Porting is performed with a new PR meaning porting PRs *must* have an
|
||||
associated "parent" PR (the original bug fix or feature PR).
|
||||
|
||||
Every PR must indicate whether it should be ported in either direction;
|
||||
*backwards* (backport) or *forwards* (forward port). This is achieved by
|
||||
adding up to two labels per PR which signal the porting requirements for the
|
||||
PR.
|
||||
|
||||
The [stable branch backports](#stable-branch-backports) section provides
|
||||
information on the sorts of changes which should be backported.
|
||||
|
||||
### Porting labels
|
||||
|
||||
The table below lists all valid combinations of GitHub labels. Every PR must
|
||||
be labelled as shown in the table row that most closely corresponds to the
|
||||
type of PR the user is raising.
|
||||
|
||||
> **Notes:**
|
||||
>
|
||||
> - The porting labels are enforced by a
|
||||
> [GitHub action](https://github.com/confidential-containers/.github/blob/main/scripts/pr-porting-checks.sh).
|
||||
> This means that *PRs that do not have a valid set of porting labels cannot be merged*.
|
||||
> - The "Common PR type" column in the table shows the most likely type of PR, but
|
||||
> this is just a guide.
|
||||
> - A `backport` or `forward-port` labelled PR **must** have an associated
|
||||
> parent PR which caused the backport or forward port PR to be raised.
|
||||
|
||||
| PR summary | Common PR type | Backport label | Forward port label | Notes |
|
||||
| --------------------------------------- | ------------------ | -------------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| A "standalone" PR | Feature | `no-backport-needed` | `no-forward-port-needed` | PR does not need to be ported. For example, a PR used to add a new feature to the latest release. |
|
||||
| PR that needs to be backported only | Bug fix | `needs-backport` | `no-forward-port-needed` | |
|
||||
| PR that needs to be forward ported only | Bug fix or feature | `no-backport-needed` | `needs-forward-port` | |
|
||||
| A backport PR | Bug fix | `backport` | | PR to actually make the backport changes.<br/><br/>Must have an associated "parent" PR.<br/><br/>Title **must** contain original PRs title. |
|
||||
| A forward port PR | Bug fix or feature | | `forward-port` | PR to actually make the forward port changes.<br/><br/>Must have an associated "parent" PR.<br/><br/>Title **must** contain original PRs title. |
|
||||
|
||||
If you are not a member of the GitHub repository the PR is raised in, you may
|
||||
not be able to see the GitHub labels. In this scenario, please add a comment
|
||||
asking for the porting labels to be applied.
|
||||
|
||||
Forward port and backport PRs by definition should not be raised in isolation:
|
||||
there must be an existing PR that caused the porting PR to be raised.
|
||||
|
||||
If you know whether a PR should be backported or forward ported, please add
|
||||
a comment on the PR if you are unable to add the appropriate labels. If you do
|
||||
not know whether a PR should be backported or forward ported, the community
|
||||
will work with you to identify any porting requirements and to help with
|
||||
porting activities.
|
||||
|
||||
### Stable branch backports
|
||||
|
||||
Confidential Containers maintains a number of stable branch releases. Bug fixes to
|
||||
the main branch are selectively applied to (or "backported") these stable branches.
|
||||
|
||||
In order to aid identification of commits that potentially should be
|
||||
backported to the stable branches, all PRs submitted must be labeled with
|
||||
one or more of the following labels. At least one label that is *not*
|
||||
`stable-candidate` must be included.
|
||||
|
||||
| Label | Meaning |
|
||||
| ------------------ | ------------------------------------------------------------- |
|
||||
| `bug` | A bug fix, which will potentially be a backport candidate |
|
||||
| `cleanup` | A cleanup, which will likely not be backported |
|
||||
| `feature` | A new feature/enhancement, that will likely not be backported |
|
||||
| `stable-candidate` | A PR selected for backporting - very likely a bug fix |
|
||||
|
||||
In the event that a bug fix PR is selected for backporting to the stable
|
||||
branches, the `stable-candidate` label is added if not already present, and
|
||||
the original author of the PR is asked if they will submit the relevant
|
||||
backport PRs.
|
||||
|
||||
### Porting issue numbers
|
||||
|
||||
For ports that are within the same repository (for example a stable backport
|
||||
to a 1.x PR), specify the same issue number as the original PR in the "fixes
|
||||
comment". See the [patch format](#patch-format) section for further details.
|
||||
|
||||
For ports in different repositories, create a new issue, referencing the
|
||||
original issue URL in the issue text.
|
||||
|
||||
## Patch format
|
||||
|
||||
### General format
|
||||
|
||||
Beside the `Signed-off-by` footer, we expect each patch to comply with the
|
||||
following format:
|
||||
|
||||
```
|
||||
subsystem: One line change summary
|
||||
|
||||
More detailed explanation of your changes (why and how)
|
||||
that spans as many lines as required.
|
||||
|
||||
A "Fixes #XXX" comment listing the GitHub issue this change resolves.
|
||||
This comment is required for the main patch in a sequence. See the following examples.
|
||||
|
||||
Signed-off-by: Contributors Name <contributor@foo.com>
|
||||
```
|
||||
|
||||
#### Pull request format
|
||||
|
||||
As shown above, pull requests must adhere to these guidelines:
|
||||
|
||||
* Preface the PR title with the appropriate keyword found in [Subsystem](#subsystem)
|
||||
|
||||
* Ensure PR title length is 75 characters or fewer, including whichever
|
||||
`subsystem` term is used.
|
||||
|
||||
* Ensure the PR body line length is 72 characters or fewer.
|
||||
|
||||
The body of the message is **not** a continuation of the subject line and is
|
||||
not used to extend the subject line beyond its character limit. The subject
|
||||
line is a complete sentence and the body is a complete, standalone paragraph.
|
||||
|
||||
### Subsystem
|
||||
|
||||
The "subsystem" describes the area of the code that the change applies to.
|
||||
It does not have to match a particular directory name in the source tree
|
||||
because it is a "hint" to the reader. The subsystem is generally a single
|
||||
word. Although the subsystem must be specified, it is not validated. The
|
||||
author decides what is a relevant subsystem for each patch.
|
||||
word.
|
||||
|
||||
Examples:
|
||||
If the commit touches many different subsystems, you might want to
|
||||
split it into multiple commits.
|
||||
In general more smaller commits are preferred to fewer larger ones.
|
||||
|
||||
| Subsystem | Description |
|
||||
| --------- | ------------------------------------------------- |
|
||||
| `build` | `Makefile` or configuration script change |
|
||||
| `cli` | Change affecting command line options or commands |
|
||||
| `docs` | Documentation change |
|
||||
| `logging` | Logging change |
|
||||
If a commit fixes an existing GitHub issue, include `Fixes: #xxx` in the commit message.
|
||||
This will help GitHub link the commit to the issue, which shows other developers that
|
||||
work is in progress.
|
||||
|
||||
To see the subsystem values chosen for existing commits:
|
||||
#### Pull Request Format
|
||||
|
||||
```sh
|
||||
$ git log --no-merges --pretty="%s" | cut -d: -f1 | sort -u
|
||||
```
|
||||
The pull request itself must also have a name and a description.
|
||||
Like a commit, the pull request name should start with a subsystem.
|
||||
Unlike a commit, the pull request description does not become part of
|
||||
the Git log.
|
||||
The PR description can be more verbose. You might include a checklist of development steps
|
||||
or questions that you would like reviewers to consider.
|
||||
You can tag particular users or link a PR to an issue or another PR.
|
||||
If your PR depends on other PRs, you should specify this in the description.
|
||||
In general, the more context you provide in the description, the easier it will be for reviewers.
|
||||
|
||||
### Best practices for patches
|
||||
|
||||
We recommend that each patch fixes one thing. Smaller patches are easier to
|
||||
review, more likely to be accepted and merged, and more conducive for
|
||||
identifying problems during review.
|
||||
### Reviews
|
||||
|
||||
A PR can contain multiple patches. These patches should generally be related
|
||||
to the [main patch](#main-patch) and the overall goal of the PR. However, it
|
||||
is also acceptable to include additional or
|
||||
[supplementary patches](#supplementary-patch) for things such as:
|
||||
In most subprojects your PR must be approved by two maintainers before it is merged.
|
||||
Reviews are also welcome from non-maintainers.
|
||||
For information about community structure, including how to become a maintainer,
|
||||
please see the [governance document](https://github.com/confidential-containers/confidential-containers/blob/main/governance.md).
|
||||
|
||||
- Formatting (or whitespace) fixes
|
||||
- Comment improvements
|
||||
- Tidy up work
|
||||
- Refactoring to simplify the codebase
|
||||
It may take a few iterations to address concerns raised by maintainers and other reviewers.
|
||||
Keep an eye on GitHub to see if you need to rebase your PR during this process.
|
||||
The web UI will report whether a PR can be automatically merged or if it conflicts
|
||||
with the base branch.
|
||||
|
||||
### Verification
|
||||
While CoCo reviewers tend to be responsive, many have a lot on their plate.
|
||||
If your PR is awaiting review, you can tag a reviewer to remind them to take a look.
|
||||
You can also ask for review in the CoCo Slack channel.
|
||||
|
||||
Correct formatting of the PR patches is verified using the
|
||||
[`checkcommits`](https://github.com/kata-containers/tests/tree/main/cmd/checkcommits)
|
||||
tool.
|
||||
|
||||
### Examples
|
||||
|
||||
#### Main patch
|
||||
|
||||
The following is an example of a full patch description for the main change that shows the required "`Fixes #XXX`" comment, which references the GitHub issue this patch resolves:
|
||||
|
||||
```
|
||||
pod: Remove token from Cmd structure
|
||||
|
||||
The token and pid data will be hold by the new Process structure and
|
||||
they are related to a container.
|
||||
|
||||
Fixes: #123
|
||||
|
||||
Signed-off-by: Sebastien Boeuf <sebastien.boeuf@intel.com>
|
||||
```
|
||||
|
||||
#### Supplementary patch
|
||||
|
||||
If a PR contains multiple patches, [only one of those patches](#main-patch) needs to specify the "`Fixes #XXX`" comment. Supplementary patches have an identical format to the main patch, but do not need to specify a "`Fixes #XXX`"
|
||||
comment.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
image-builder: Fix incorrect error message
|
||||
|
||||
Fixed an error message which was referring to an incorrect rootfs
|
||||
variable name.
|
||||
|
||||
Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
|
||||
```
|
||||
|
||||
## Reviews
|
||||
|
||||
Before your PRs are merged into the main code base, they are reviewed. We
|
||||
encourage anybody to review any PR and leave feedback.
|
||||
|
||||
See the [PR review guide](PR-Review-Guide.md) for tips on performing a
|
||||
careful review.
|
||||
|
||||
We use the GitHub [Required Reviews](https://help.github.com/articles/approving-a-pull-request-with-required-reviews/)
|
||||
system for reviewers to note if they agree or disagree with a PR. To have
|
||||
an acknowledgment or "nack" registered with GitHub, you **must** use the
|
||||
GitHub "Review changes" dialog to leave feedback. Notes left only in the
|
||||
comments fields, whilst sometimes useful, will not get registered
|
||||
in the acknowledgment counting system.
|
||||
|
||||
### Review Examples
|
||||
|
||||
The following is an example of a valid "ack", as long as
|
||||
the "Approve" box is ticked in the Review changes dialog:
|
||||
|
||||
```
|
||||
Excellent work - thanks for your contribution.
|
||||
|
||||
lgtm
|
||||
```
|
||||
|
||||
## Continuous Integration
|
||||
|
||||
The Confidential Containers project has a gating process to prevent introducing
|
||||
regressions. When your PR is submitted, a Continuous Integration (CI) system
|
||||
will run different checks on different platforms, based upon your changes.
|
||||
### Continuous Integration
|
||||
|
||||
All subprojects have some form of CI and require some checks to
|
||||
pass before a PR can be merged.
|
||||
Some of the checks are:
|
||||
|
||||
- Static analysis checks.
|
||||
@@ -670,25 +196,9 @@ Some of the checks are:
|
||||
- Functional tests.
|
||||
- Integration tests.
|
||||
|
||||
The CI jobs will wait to be triggered. A maintainer must add a `/test`
|
||||
comment on the PR to let the CI jobs run.
|
||||
If your PR does not pass a check, try to find the cause of the failure.
|
||||
If the cause is not related to your changes, you can ask a reviewer to re-run
|
||||
the tests or help troubleshoot.
|
||||
|
||||
All CI jobs must pass in order to merge your PR.
|
||||
|
||||
## Contact
|
||||
|
||||
The Confidential Containers community can be reached
|
||||
[through various channels](README.md#join-us).
|
||||
|
||||
## Project maintainers
|
||||
|
||||
The Confidential Containers project maintainers are the people accepting or
|
||||
rejecting any PR. Although [anyone can review PRs](#reviews), only the
|
||||
acknowledgement (or "ack") from an Approver counts towards the approval of a PR.
|
||||
|
||||
Approvers are listed in GitHub teams, one for each repository. The project
|
||||
uses the
|
||||
[GitHub required status checks](https://help.github.com/en/articles/enabling-required-status-checks)
|
||||
along with the [GitHub `CODEOWNERS`file](https://help.github.com/en/articles/about-code-owners) to specify who can approve PRs. All repositories are configured to require:
|
||||
|
||||
- Two approvals from the repository-specific approval team.
|
||||
With this guide, you're well-prepared to contribute effectively to Confidential Containers. We appreciate your involvement in our open-source community!
|
||||
|
@@ -2,6 +2,8 @@
|
||||
|
||||
# Confidential Containers
|
||||
|
||||
[](https://bestpractices.coreinfrastructure.org/projects/5719)
|
||||
|
||||
## Welcome to confidential-containers
|
||||
|
||||
Confidential Containers is an open source community working to leverage
|
||||
@@ -42,3 +44,4 @@ delivering Confidential Computing for guest applications or data inside the TEE
|
||||
|
||||
## License
|
||||
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fconfidential-containers%2Fcommunity?ref=badge_large)
|
||||
|
||||
|
@@ -20,6 +20,8 @@ spec:
|
||||
metadata:
|
||||
labels:
|
||||
app: ccv0-ssh
|
||||
annotations:
|
||||
io.containerd.cri.runtime-handler: kata
|
||||
spec:
|
||||
runtimeClassName: kata
|
||||
containers:
|
||||
|
@@ -73,18 +73,66 @@ Further, as leaders in the community, the SC members will make themselves famili
|
||||
|
||||
### Members
|
||||
|
||||
The initial composition of the SC is self-defined and is made of 10 members:
|
||||
The current members of the SC are:
|
||||
|
||||
* Larry Dewey (@larrydewey) - AMD
|
||||
* Larry Dewey (@larrydewey) and Ryan Savino (@ryansavino) - AMD
|
||||
* Jiang Liu (@jiangliu) and Jia Zhang (@jiazhang0) - Alibaba
|
||||
* James Magowan (@magowan) and Tobin Feldman-Fitzthum (@fitzthum) - IBM
|
||||
* Peter Zhu (@peterzcst) and Dan Middleton (@dcmiddle) - Intel
|
||||
* Peter Zhu (@peterzcst) and Mikko Ylinen (@mythi) - Intel
|
||||
* Pradipta Banerjee (@bpradipt) and Ariel Adam (@ariel-adam) - Red Hat
|
||||
* Samuel Ortiz (@sameo)
|
||||
* Samuel Ortiz (@sameo) - Rivos
|
||||
* Zvonko Kaiser (@zvonkok) - NVIDIA
|
||||
* Vincent Batts (@vbatts) and Dan Mihai (@danmihai1) - Microsoft
|
||||
|
||||
### Emeritus Members
|
||||
|
||||
* Dan Middleton [dcmiddle](https://github.com/dcmiddle) (he/him)
|
||||
|
||||
#### Selection
|
||||
|
||||
The initial SC members will be responsible for defining how and when the SC membership can be expanded or renewed.
|
||||
The convention of the SC is for each organization that is significantly engaged
|
||||
in the project to be represented by one or two members.
|
||||
In addition to a company, an organization could also refer to a
|
||||
non-corporate institution such as school.
|
||||
Selection of the representatives of each organization is not within scope
|
||||
of the SC.
|
||||
The organization itself should select the individual(s) to represent it.
|
||||
Membership changes can fall into one of four categories,
|
||||
as described in the following sections.
|
||||
Each of these processes should be initiated by opening a PR against
|
||||
this document, explaining the motivations of the change and introducing
|
||||
any potential new members.
|
||||
Membership changes can be approved via GitHub and do not require an SC meeting.
|
||||
|
||||
##### Expansion
|
||||
|
||||
The SC can be expanded if a new organization begins making significant contributions
|
||||
to the project.
|
||||
When evaluating requests for expansion, the SC will mainly consider whether
|
||||
the organization in question is making significant contributions to the community.
|
||||
There is no standard definition for significant contributions.
|
||||
The SC should prioritize including relevant stakeholders.
|
||||
The candidates from a organization are understood to represent
|
||||
that organization. The SC may do some basic checks to ensure that
|
||||
candidates are familiar with the project and represent relevant contributors.
|
||||
Expansion should be approved by at least 2/3rds of current SC members.
|
||||
|
||||
##### Replacement
|
||||
|
||||
An SC member can replace themselves with another member from the same organization at will.
|
||||
This is understood to represent a decision by that organization.
|
||||
If the SC contains another member from the same organization, they must approve the replacement.
|
||||
Otherwise, unless there are significant concerns that the change does not represent the
|
||||
organization in question, a vote is not required to approve a replacement.
|
||||
|
||||
##### Recusal
|
||||
|
||||
An individual can remove themselves from the SC at any time. A vote is not required for recusal.
|
||||
|
||||
##### Removal
|
||||
|
||||
A member can be removed from the SC in the case of gross violation of the Code of Conduct.
|
||||
This should be done only in exceptional circumstances and requires a unanimous vote of remaining SC members.
|
||||
|
||||
### Decision-making
|
||||
|
||||
@@ -95,10 +143,17 @@ The main goal is not to get full agreement from all SC members on a final decisi
|
||||
|
||||
Voting on a decision proposal should be used as a last resort solution, as it can potentially leave several SC members major concerns unaddressed.
|
||||
|
||||
Some procedural decisions, such as expansion, can be approved without an SC meeting. This is done via GitHub and requires approval by
|
||||
2/3rds of SC members. If an SC member feels that further discussion is required a meeting can be called, even if the PR has otherwise been approved.
|
||||
If a meeting is called, the above procedure should be followed.
|
||||
|
||||
Community members who are not on the SC are also welcome to submit non-binding feedback regarding any SC process.
|
||||
|
||||
### Meeting
|
||||
|
||||
The SC meets every other week. Meeting time may change depending on the composition of the SC, in order to adapt to SC members local time zones.
|
||||
The meeting is public and recorded, and follows a [publicly available agenda](https://docs.google.com/document/d/15epr-ZDmlIp-8jR0HQAaK0aXNddYp-gdwZnvUFQysLw/edit?usp=sharing).
|
||||
The SC will determine an appropriate cadence for meeting and may schedule additional meetings when needed.
|
||||
Meeting time may change depending on the composition of the SC, in order to adapt to SC members local time zones.
|
||||
The meeting is public and recorded, and follows a [publicly available agenda](https://docs.google.com/document/d/1YNbkUlcosjN1MFKvs3bJ0CAIZJEp-UEFALW8lDgilLU).
|
||||
|
||||
The SC meeting scope is different from the weekly [Confidential Containers community meeting](https://docs.google.com/document/d/1E3GLCzNgrcigUlgWAZYlgqNTdVwiMwCRTJ0QnJhLZGA/edit?usp=sharing), the latter being mostly focused on specific and technical details of one or more Confidential Containers project.
|
||||
|
||||
|
@@ -1,5 +1,7 @@
|
||||
# EAA Verdictd Guide
|
||||
|
||||
**EAA/Verdictd support has been deprecated in Confidential Containers**
|
||||
|
||||
EAA is used to perform attestation at runtime and provide guest with confidential resources such as keys.
|
||||
It is based on [rats-tls](https://github.com/inclavare-containers/rats-tls).
|
||||
|
||||
|
@@ -7,12 +7,16 @@ section of the [quickstart guide](../quickstart.md).
|
||||
|
||||
## Configuring enclave-cc custom resource to use a different KBC
|
||||
|
||||
**Note** Before configuring KBC, please refer to the
|
||||
[guide](../quickstart.md#deploy-and-configure-tenant-side-coco-key-broker-system-cluster) to deploy KBS cluster.
|
||||
|
||||
**Note** The KBC configuration changes to the enclave-cc custom resource yaml
|
||||
must be made **before** deploying it.
|
||||
|
||||
Enclave CC supports Verdictd and in order to use it, users will have to
|
||||
properly configure a decrypt_config.conf, in order to set the `KBC` (`sample_kbc`
|
||||
or `eaa_kbc`) `IP`,`PORT`, and the `SECURITY_VALIDATE` (`false` or `true`)
|
||||
Enclave CC supports cc-kbc and sample-kbc, in order to use them, users will have to
|
||||
properly configure a `decrypt_config.conf`, in order to set the `KBC` (`cc_kbc`
|
||||
or `sample_kbc`) `IP`,`PORT`, and the `SECURITY_VALIDATE` (`false` or `true`).
|
||||
|
||||
```json
|
||||
{
|
||||
"key_provider": "provider:attestation-agent:KBC::IP:PORT",
|
||||
@@ -20,6 +24,23 @@ or `eaa_kbc`) `IP`,`PORT`, and the `SECURITY_VALIDATE` (`false` or `true`)
|
||||
}
|
||||
```
|
||||
|
||||
The following is an example of `cc_kbc`:
|
||||
|
||||
```json
|
||||
{
|
||||
"key_provider": "provider:attestation-agent:cc_kbc::http://127.0.0.1:8080",
|
||||
"security_validate": true
|
||||
}
|
||||
```
|
||||
The following is an example of `sample_kbc`:
|
||||
|
||||
```json
|
||||
{
|
||||
"key_provider": "provider:attestation-agent:sample_kbc::127.0.0.1:50000",
|
||||
"security_validate": false
|
||||
}
|
||||
```
|
||||
|
||||
Once that's set according to the users needs, the user will then have to run:
|
||||
`cat decrypt_config.conf | base64 -w 0` in order to get the data encoded and
|
||||
set it accordingly [here](https://github.com/confidential-containers/operator/blob/6f241fbc056f0a5d9e1bd2c10b2cedc0782b99ff/config/samples/enclave-cc/base/ccruntime-enclave-cc.yaml#L124).
|
||||
@@ -27,7 +48,11 @@ set it accordingly [here](https://github.com/confidential-containers/operator/bl
|
||||
## Creating a sample CoCo workload using enclave-cc
|
||||
|
||||
As an example, we setup a sample *hello world*
|
||||
workload with an encrypted and cosign signed container image using the `enclave-cc` runtime class for process based TEEs.
|
||||
workload with an encrypted and cosign signed container image using the `enclave-cc` runtime class for process based TEEs.
|
||||
This encrypted image is only used for testing.
|
||||
If you want to use it in your own production use cases, please refer to
|
||||
the [guide](../quickstart.md#encrypting-an-image) to create a new encrypted image and deploy it.
|
||||
|
||||
The deployment below assumes the hardware SGX mode build is installed by the operator. To try on a non-TEE system, please
|
||||
use simulate SGX mode build.
|
||||
|
||||
|
@@ -12,6 +12,8 @@ apiVersion: v1
|
||||
kind: Pod
|
||||
metadata:
|
||||
name: trusted-lvm-block
|
||||
annotations:
|
||||
io.containerd.cri.runtime-handler: kata-qemu-tdx
|
||||
spec:
|
||||
runtimeClassName: kata-qemu-tdx
|
||||
containers:
|
||||
|
@@ -1,90 +0,0 @@
|
||||
# Encrypted Container Images without Hardware Support
|
||||
|
||||
Without Confidential Computing hardware, there is no way to securely provision
|
||||
the keys for an encrypted image. Nonetheless, in this demo we describe how to
|
||||
test encrypted images support with the non-tee `kata`/`kata-qemu` runtimeclass.
|
||||
|
||||
## Creating a CoCo workload using a pre-existing encrypted image
|
||||
|
||||
We will now proceed to download and run a sample encrypted container image using the CoCo building blocks.
|
||||
|
||||
A demo container image is provided at [docker.io/katadocker/ccv0-ssh](https://hub.docker.com/r/katadocker/ccv0-ssh).
|
||||
It is encrypted with [Attestation Agent](https://github.com/confidential-containers/attestation-agent)'s [offline file system key broker](https://github.com/confidential-containers/attestation-agent/tree/64c12fbecfe90ba974d5fe4896bf997308df298d/src/kbc_modules/offline_fs_kbc) and [`aa-offline_fs_kbc-keys.json`](https://github.com/confidential-containers/documentation/blob/main/demos/ssh-demo/aa-offline_fs_kbc-keys.json) as its key file.
|
||||
|
||||
We have prepared a sample CoCo operator custom resource that is based on the standard `ccruntime.yaml`, but in addition has the the decryption keys and configuration required to decrypt this sample container image.
|
||||
> **Note** All pods started with this sample resource will be able to decrypt the sample container and all keys shown are for demo purposes only and should not be used in production.
|
||||
|
||||
To test out creating a workload from the sample encrypted container image, we can take the following steps:
|
||||
|
||||
### Swap out the standard custom resource for our sample
|
||||
|
||||
Support for multiple custom resources in not available in the current release. Consequently, if a custom resource already exists, then you'll need to remove it first before deploying a new one. We can remove the standard custom resource with:
|
||||
```sh
|
||||
kubectl delete -k github.com/confidential-containers/operator/config/samples/ccruntime/<CCRUNTIME_OVERLAY>?ref=<RELEASE_VERSION>
|
||||
```
|
||||
and in it's place install the modified version with the sample container's decryption key:
|
||||
```sh
|
||||
kubectl apply -k github.com/confidential-containers/operator/config/samples/ccruntime/ssh-demo?ref=<RELEASE_VERSION>
|
||||
```
|
||||
Wait until each pod has the STATUS of Running.
|
||||
```sh
|
||||
kubectl get pods -n confidential-containers-system --watch
|
||||
```
|
||||
### Test creating a workload from the sample encrypted image
|
||||
|
||||
Create a new Kubernetes deployment that uses the `docker.io/katadocker/ccv0-ssh` container image with:
|
||||
```sh
|
||||
cat << EOF > ccv0-ssh-demo.yaml
|
||||
kind: Service
|
||||
apiVersion: v1
|
||||
metadata:
|
||||
name: ccv0-ssh
|
||||
spec:
|
||||
selector:
|
||||
app: ccv0-ssh
|
||||
ports:
|
||||
- port: 22
|
||||
---
|
||||
kind: Deployment
|
||||
apiVersion: apps/v1
|
||||
metadata:
|
||||
name: ccv0-ssh
|
||||
spec:
|
||||
selector:
|
||||
matchLabels:
|
||||
app: ccv0-ssh
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: ccv0-ssh
|
||||
spec:
|
||||
runtimeClassName: kata
|
||||
containers:
|
||||
- name: ccv0-ssh
|
||||
image: docker.io/katadocker/ccv0-ssh
|
||||
imagePullPolicy: Always
|
||||
EOF
|
||||
```
|
||||
|
||||
Apply this with:
|
||||
```sh
|
||||
kubectl apply -f ccv0-ssh-demo.yaml
|
||||
```
|
||||
and wait for the pod to start. This process should show that we are able to pull the encrypted image, and using the decryption key configured in the CoCo sample guest image, decrypt the container image and create a workload using it.
|
||||
|
||||
The demo image has an SSH host key embedded in it, which is protected by it's encryption, but we can download the sample private key and use this to ssh into the container to validate it hasn't been tampered with.
|
||||
|
||||
Download the SSH key with:
|
||||
```sh
|
||||
curl -Lo ccv0-ssh https://raw.githubusercontent.com/confidential-containers/documentation/main/demos/ssh-demo/ccv0-ssh
|
||||
```
|
||||
Ensure that the permissions are set correctly with:
|
||||
```sh
|
||||
chmod 600 ccv0-ssh
|
||||
```
|
||||
|
||||
We can then use the key to ssh into the container:
|
||||
```sh
|
||||
$ ssh -i ccv0-ssh root@$(kubectl get service ccv0-ssh -o jsonpath="{.spec.clusterIP}")
|
||||
```
|
||||
You will be prompted about whether the host key fingerprint is correct. This fingerprint should match the one specified in the container image: `wK7uOpqpYQczcgV00fGCh+X97sJL3f6G1Ku4rvlwtR0.`
|
@@ -87,19 +87,7 @@ The image encryption key and key for SSH access have been attached to the CoCo s
|
||||
|
||||
To learn more about creating custom policies, see the section on [Creating a simple-kbs Policy to Verify the SEV Firmware Measurement](#creating-a-simple-kbs-policy-to-verify-the-sev-firmware-measurement).
|
||||
|
||||
`docker-compose` is required to run the `simple-kbs` and its database in docker containers:
|
||||
|
||||
* Debian / Ubuntu:
|
||||
|
||||
```
|
||||
sudo apt install docker-compose
|
||||
```
|
||||
|
||||
* CentOS / Fedora / RHEL:
|
||||
|
||||
```
|
||||
sudo dnf install docker-compose-plugin
|
||||
```
|
||||
`docker compose` is required to run the `simple-kbs` and its database in docker containers. Installation instructions are available on [Docker's website](https://docs.docker.com/compose/install/linux/).
|
||||
|
||||
Clone the repository for specified tag:
|
||||
```
|
||||
@@ -108,19 +96,11 @@ git clone https://github.com/confidential-containers/simple-kbs.git
|
||||
(cd simple-kbs && git checkout -b "branch_${simple_kbs_tag}" "${simple_kbs_tag}")
|
||||
```
|
||||
|
||||
Run the service with `docker-compose`:
|
||||
Run the service with `docker compose`:
|
||||
|
||||
* Debian / Ubuntu:
|
||||
|
||||
```
|
||||
(cd simple-kbs && sudo docker-compose up -d)
|
||||
```
|
||||
|
||||
* CentOS / Fedora / RHEL:
|
||||
|
||||
```
|
||||
(cd simple-kbs && sudo docker compose up -d)
|
||||
```
|
||||
```
|
||||
(cd simple-kbs && sudo docker compose up -d)
|
||||
```
|
||||
|
||||
### Launch the Pod and Verify SEV Encryption
|
||||
|
||||
@@ -149,6 +129,8 @@ spec:
|
||||
metadata:
|
||||
labels:
|
||||
app: encrypted-image-tests
|
||||
annotations:
|
||||
io.containerd.cri.runtime-handler: kata-qemu-sev
|
||||
spec:
|
||||
runtimeClassName: kata-qemu-sev
|
||||
containers:
|
||||
|
@@ -63,9 +63,9 @@ with the desired [release tag](https://github.com/confidential-containers/operat
|
||||
kubectl apply -k github.com/confidential-containers/operator/config/release?ref=<RELEASE_VERSION>
|
||||
```
|
||||
|
||||
For example, to deploy the `v0.3.0` release run:
|
||||
For example, to deploy the `v0.8.0` release run:
|
||||
```
|
||||
kubectl apply -k github.com/confidential-containers/operator/config/release?ref=v0.3.0
|
||||
kubectl apply -k github.com/confidential-containers/operator/config/release?ref=v0.8.0
|
||||
```
|
||||
|
||||
Wait until each pod has the STATUS of Running.
|
||||
@@ -76,6 +76,8 @@ kubectl get pods -n confidential-containers-system --watch
|
||||
|
||||
### Create the custom resource
|
||||
|
||||
#### Create custom resource for kata
|
||||
|
||||
Creating a custom resource installs the required CC runtime pieces into the cluster node and creates
|
||||
the `RuntimeClasses`
|
||||
|
||||
@@ -85,14 +87,14 @@ kubectl apply -k github.com/confidential-containers/operator/config/samples/ccru
|
||||
|
||||
The current present overlays are: `default` and `s390x`
|
||||
|
||||
For example, to deploy the `v0.3.0` release for `x86_64`, run:
|
||||
For example, to deploy the `v0.8.0` release for `x86_64`, run:
|
||||
```
|
||||
kubectl apply -k github.com/confidential-containers/operator/config/samples/ccruntime/default?ref=v0.3.0
|
||||
kubectl apply -k github.com/confidential-containers/operator/config/samples/ccruntime/default?ref=v0.8.0
|
||||
```
|
||||
|
||||
And to deploy `v0.3.0` release for `s390x`, run:
|
||||
And to deploy `v0.8.0` release for `s390x`, run:
|
||||
```
|
||||
kubectl apply -k github.com/confidential-containers/operator/config/samples/ccruntime/s390x?ref=v0.3.0
|
||||
kubectl apply -k github.com/confidential-containers/operator/config/samples/ccruntime/s390x?ref=v0.8.0
|
||||
```
|
||||
|
||||
Wait until each pod has the STATUS of Running.
|
||||
@@ -104,7 +106,10 @@ kubectl get pods -n confidential-containers-system --watch
|
||||
#### Create custom resource for enclave-cc
|
||||
|
||||
**Note** For `enclave-cc` certain configuration changes, such as setting the
|
||||
URI of the KBS, must be made **before** applying the custom resource.
|
||||
URI of the KBS, must be made **before** applying the custom resource.
|
||||
Please refer to the [guide](./guides/enclave-cc.md#configuring-enclave-cc-custom-resource-to-use-a-different-kbc)
|
||||
to modify the enclave-cc configuration.
|
||||
|
||||
Please see the [enclave-cc guide](./guides/enclave-cc.md) for more information.
|
||||
|
||||
`enclave-cc` is a form of Confidential Containers that uses process-based isolation.
|
||||
@@ -179,6 +184,8 @@ metadata:
|
||||
labels:
|
||||
run: nginx
|
||||
name: nginx
|
||||
annotations:
|
||||
io.containerd.cri.runtime-handler: kata
|
||||
spec:
|
||||
containers:
|
||||
- image: bitnami/nginx:1.22.0
|
||||
@@ -236,9 +243,6 @@ Secrets are provisioned to the guest in conjunction with an attestation, which i
|
||||
The rest of this guide focuses on setting up more substantial encrypted/signed workloads using attestation
|
||||
and confidential hardware.
|
||||
|
||||
See [this guide](./guides/nontee_demo.md) if you would like to deploy an example encrypted image without
|
||||
confidential hardware.
|
||||
|
||||
CoCo has a modular attestation interface and there are a few options for attestation.
|
||||
CoCo provides a generic Key Broker Service (KBS) that the rest of this guide will be focused on.
|
||||
The SEV runtime class uses `simple-kbs`, which is described in the [SEV guide](./guides/sev.md).
|
||||
@@ -265,12 +269,12 @@ A tenant-side CoCo Key Broker System cluster includes:
|
||||
- Reference Value Provicer Service (RVPS): Provides reference values for AS.
|
||||
- CoCo Keyprovider: Component to encrypt the images following ocicrypt spec.
|
||||
|
||||
To quick start the KBS cluster, a `docker-compose` yaml is provided to launch.
|
||||
To quick start the KBS cluster, a `docker compose` yaml is provided to launch.
|
||||
|
||||
```shell
|
||||
# Clone KBS git repository
|
||||
git clone https://github.com/confidential-containers/kbs.git
|
||||
cd kbs
|
||||
cd kbs/kbs
|
||||
export KBS_DIR_PATH=$(pwd)
|
||||
|
||||
# Generate a user auth key pair
|
||||
@@ -278,10 +282,10 @@ openssl genpkey -algorithm ed25519 > config/private.key
|
||||
openssl pkey -in config/private.key -pubout -out config/public.pub
|
||||
|
||||
# Start KBS cluster
|
||||
docker-compose up -d
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
If configuration of KBS cluster is required, edit the following config files and restart the KBS cluster with `docker-compose`:
|
||||
If configuration of KBS cluster is required, edit the following config files and restart the KBS cluster with `docker compose`:
|
||||
|
||||
- `$KBS_DIR_PATH/config/kbs-config.json`: configuration for Key Broker Service.
|
||||
- `$KBS_DIR_PATH/config/as-config.json`: configuration for Attestation Service.
|
||||
@@ -387,6 +391,8 @@ metadata:
|
||||
labels:
|
||||
run: encrypted-image-test-busybox
|
||||
name: encrypted-image-test-busybox
|
||||
annotations:
|
||||
io.containerd.cri.runtime-handler: [RUNTIME_CLASS]
|
||||
spec:
|
||||
containers:
|
||||
- image: [REGISTRY_URL]:encrypted
|
||||
@@ -398,7 +404,7 @@ EOT
|
||||
|
||||
Be sure to replace `[REGISTRY_URL]` with the desired registry URL of the encrypted image generated in previous step, replace `[RUNTIME_CLASS]` with kata runtime class for CC HW.
|
||||
|
||||
Then configure `/opt/confidential-containers/share/defaults/kata-containers/configuration-<RUNTIME_CLASS_SUFFIX>.toml` to add `agent.aa_kbc_params=cc_kbc::<KBS_URI>` to kernal parameters. Here `RUNTIME_CLASS_SUFFIX` is something like `qemu-tdx`, `KBS_URI` is the address of Key Broker Service in KBS cluster like `http://123.123.123.123:8080`.
|
||||
Then configure `/opt/confidential-containers/share/defaults/kata-containers/configuration-<RUNTIME_CLASS_SUFFIX>.toml` to add `agent.aa_kbc_params=cc_kbc::<KBS_URI>` to kernel parameters. Here `RUNTIME_CLASS_SUFFIX` is something like `qemu-tdx`, `KBS_URI` is the address of Key Broker Service in KBS cluster like `http://123.123.123.123:8080`.
|
||||
|
||||
Deploy encrypted image as a workload:
|
||||
|
||||
|
91
releases/v0.8.0.md
Normal file
91
releases/v0.8.0.md
Normal file
@@ -0,0 +1,91 @@
|
||||
# Release Notes for v0.8.0
|
||||
|
||||
Release Date: November 10th, 2023
|
||||
|
||||
Please see the [quickstart guide](../quickstart.md) for details on how to try out Confidential
|
||||
Containers.
|
||||
|
||||
Please refer to our [Acronyms](https://github.com/confidential-containers/documentation/wiki/Acronyms)
|
||||
and [Glossary](https://github.com/confidential-containers/documentation/wiki/Glossary) pages for a
|
||||
definition of the acronyms used in this document.
|
||||
|
||||
## What's new
|
||||
|
||||
* Upstream containerd supported by all deployment types except enclave-cc.
|
||||
* This release includes the Nydus snapshotter (for the first time) to support upstream containerd.
|
||||
* In this release images are still pulled inside the guest.
|
||||
* **Nydus snapshotter requires the following annotation for each pod `io.containerd.cri.runtime-handler: <runtime-class`.**
|
||||
* Support for Nydus snapshotter in peer pods is still experimental. To avoid using it with peer pods do not set above annotation.
|
||||
* Nydus snapshotter support in general is still evolving. See limitations section below for details.
|
||||
* A new component, the Confidential Data Hub (CDH) is now deployed inside the guest.
|
||||
* CDH is an evolution of the Attestation Agent that supports advanced features.
|
||||
* CDH supports sealed Kubernetes secrets which are managed by the control plane, but securely unwrapped inside the enclave.
|
||||
* CDH supports connections to both KBS and KMS.
|
||||
* New architecture of Attestation Agent and CDH allows a client to deploy multiple KBSes.
|
||||
* One KBS can be used for validating evidence with the Attestation Service while another can provide resources.
|
||||
* Pulling from an authenticated registry now requires `imagePullSecrets`.
|
||||
|
||||
**Peer Pods**
|
||||
* `peerpod-ctl` tool has been expanded.
|
||||
* Can check and clean old peerpod objects
|
||||
* Adds SSH authentication support to libvirt provider
|
||||
* Supports IBM cloud
|
||||
* Support for secure key release at runtime and image decryption via remote attestation on AKS
|
||||
* Added AMD SEV and IBM s390x support for the Libvirt provider
|
||||
* Container registry authentication now bootstrapped from userdata.
|
||||
* Enabled public IP usage for pod VM on AWS and PowerVS providers
|
||||
* webhook: added IBM ppc64le platform support
|
||||
* Support adding custom tags to podvm instances
|
||||
* Switched to launching CVM by default on AWS and Azure providers
|
||||
* Added rollingUpdate strategy in cloud-api-adaptor daemonset
|
||||
* Disabled secureboot by default
|
||||
|
||||
## Hardware Support
|
||||
|
||||
Confidential Containers is tested with attestation on the following platforms:
|
||||
|
||||
* Intel TDX
|
||||
* AMD SEV(-ES)
|
||||
* Intel SGX
|
||||
|
||||
The following platforms are untested or partially supported:
|
||||
|
||||
* IBM Secure Execution (SE) on IBM zSystems (s390x) running LinuxONE
|
||||
* AMD SEV-SNP
|
||||
* ARM CCA
|
||||
|
||||
## Limitations
|
||||
|
||||
The following are known limitations of this release:
|
||||
|
||||
* Nydus snapshotter support is not mature.
|
||||
* Nydus snapshot sometimes conflicts with existing node configuration.
|
||||
* You may need to remove existing container images/snapshots before installing Nydus snapshotter.
|
||||
* Nydus snapshotter may not support pulling one image with multiple runtime handler annotations even across different pods.
|
||||
* Host pulling with Nydus snapshotter is not yet enabled.
|
||||
* Nydus snapshotter is not supported with enclave-cc.
|
||||
* Pulling container images inside guest may have negative performance implications including greater resource usage and slower startup.
|
||||
* `crio` support is still evolving.
|
||||
* Platform support is rapidly changing
|
||||
* Image signature validation with AMD SEV-ES is not covered by CI.
|
||||
* SELinux is not supported on the host and must be set to permissive if in use.
|
||||
* The generic KBS does not yet supported all platforms.
|
||||
* The format of encrypted container images is still subject to change
|
||||
* The [oci-crypt](https://github.com/containers/ocicrypt) container image format itself may still change
|
||||
* The tools to generate images are not in their final form
|
||||
* The image format itself is subject to change in upcoming releases
|
||||
* Not all image repositories support encrypted container images.
|
||||
Complete integration with Kubernetes is still in progress.
|
||||
* OpenShift support is not yet complete.
|
||||
* Existing APIs do not fully support the CoCo security and threat model. [More info](https://github.com/confidential-containers/community/issues/53)
|
||||
* Some commands accessing confidential data, such as `kubectl exec`, may either fail to work, or incorrectly expose information to the host
|
||||
* The CoCo community aspires to adopting open source security best practices, but not all practices are adopted yet.
|
||||
* We track our status with the OpenSSF Best Practices Badge, which improved to 69% at the time of this release.
|
||||
* Vulnerability reporting mechanisms still need to be created. Public github issues are still appropriate for this release until private reporting is established.
|
||||
* Container metadata such as environment variables are not measured.
|
||||
* Kata Agent does not validate mount requests. A malicious host might be able to mount a shared filesystem into the PodVM.
|
||||
|
||||
## CVE Fixes
|
||||
|
||||
None
|
||||
|
79
releases/v0.9.0-alpha0.md
Normal file
79
releases/v0.9.0-alpha0.md
Normal file
@@ -0,0 +1,79 @@
|
||||
# Release Notes for v0.9.0-alpha
|
||||
|
||||
Release Date: May 2nd, 2024
|
||||
|
||||
This is our first release based on Kata Containers main, but it is an alpha release that supports
|
||||
only a subset of features.
|
||||
|
||||
This release is based on [3.4.0](https://github.com/kata-containers/kata-containers/releases/tag/3.4.0) of Kata Containers
|
||||
and [v0.9.0](https://github.com/confidential-containers/enclave-cc/releases/tag/v0.9.0) of enclave-cc.
|
||||
|
||||
This release supports pulling images inside of the guest with some caveats but it does
|
||||
not support pulling encrypted or signed images inside the guest.
|
||||
This release supports attestation and includes the guest components in the rootfs,
|
||||
but it does not support any TEE platform.
|
||||
Peer pods is also not supported.
|
||||
|
||||
**This release was created mainly for development purposes. For a full feature set,
|
||||
consider returning to v0.8.0 or using the next release.**
|
||||
|
||||
Please see the [quickstart guide](../quickstart.md) for details on how to try out Confidential
|
||||
Containers.
|
||||
|
||||
Please refer to our [Acronyms](https://github.com/confidential-containers/documentation/wiki/Acronyms)
|
||||
and [Glossary](https://github.com/confidential-containers/documentation/wiki/Glossary) pages for a
|
||||
definition of the acronyms used in this document.
|
||||
|
||||
## What's new
|
||||
|
||||
* This release is built from the main branch of Kata Containers.
|
||||
* Non-tee attestation is now based on a sample attester and verifier rather than on `offline_fs_kbc`.
|
||||
* Resources can be dynamically delivered in confidential environments.
|
||||
* Trustee is integrated into the Kata Containers CI.
|
||||
* All platforms now share one confidential rootfs.
|
||||
* All platforms share one confidential guest kernel.
|
||||
* Image request timeout is configurable to facilitate pulling large images.
|
||||
* Attestation Agent now supports generic `configfs-tsm` ABI for collecting evidence.
|
||||
* Enclave-cc moves to unified LibOS bundle for secure rootfs key handling and to the latest Occlum v0.30.1 release that adds SGX EDMM support for dynamically adjusting the enclave size.
|
||||
* Adoption of a project-wide security reporting protocol
|
||||
|
||||
## Hardware Support
|
||||
|
||||
This release does not officially support any hardware platforms.
|
||||
It is mainly intended for testing in non-tee environments.
|
||||
Future releases will return to previous levels of support.
|
||||
|
||||
## Limitations
|
||||
|
||||
The following are known limitations of this release:
|
||||
|
||||
* Nydus snapshotter support is not mature.
|
||||
* Nydus snapshot sometimes conflicts with existing node configuration.
|
||||
* You may need to remove existing container images/snapshots before installing Nydus snapshotter.
|
||||
* Nydus snapshotter may not support pulling one image with multiple runtime handler annotations even across different pods.
|
||||
* These limitations can apply to the pause image when filesystem passthrough is not enabled.
|
||||
* Host pulling with Nydus snapshotter is not yet enabled.
|
||||
* Nydus snapshotter is not supported with enclave-cc.
|
||||
* Pulling container images inside guest may have negative performance implications including greater resource usage and slower startup.
|
||||
* `crio` support is still evolving.
|
||||
* Platform support is rapidly changing
|
||||
* SELinux is not supported on the host and must be set to permissive if in use.
|
||||
* The format of encrypted container images is still subject to change
|
||||
* The [oci-crypt](https://github.com/containers/ocicrypt) container image format itself may still change
|
||||
* The tools to generate images are not in their final form
|
||||
* The image format itself is subject to change in upcoming releases
|
||||
* Not all image repositories support encrypted container images.
|
||||
* Complete integration with Kubernetes is still in progress.
|
||||
* OpenShift support is not yet complete.
|
||||
* Existing APIs do not fully support the CoCo security and threat model. [More info](https://github.com/confidential-containers/community/issues/53)
|
||||
* Some commands accessing confidential data, such as `kubectl exec`, may either fail to work, or incorrectly expose information to the host
|
||||
* The CoCo community aspires to adopting open source security best practices, but not all practices are adopted yet.
|
||||
* We track our status with the OpenSSF Best Practices Badge, which improved to 75% at the time of this release.
|
||||
* Community has adopted a security reporting protocol, but application and documentation of static and dynamic analysis still needed.
|
||||
* Container metadata such as environment variables are not measured.
|
||||
* Kata Agent does not validate mount requests. A malicious host might be able to mount a shared filesystem into the PodVM.
|
||||
|
||||
## CVE Fixes
|
||||
|
||||
None
|
||||
|
68
releases/v0.9.0-alpha1.md
Normal file
68
releases/v0.9.0-alpha1.md
Normal file
@@ -0,0 +1,68 @@
|
||||
# Release Notes for v0.9.0-alpha1
|
||||
|
||||
Release Date: June 21st, 2024
|
||||
|
||||
This release is based on [3.6.0](https://github.com/kata-containers/kata-containers/releases/tag/3.4.0) of Kata Containers
|
||||
and [v0.9.1](https://github.com/confidential-containers/enclave-cc/releases/tag/v0.9.0) of enclave-cc.
|
||||
|
||||
This is an alpha release, with some limitations, but it builds significantly on the previous release.
|
||||
For a full feature set, please use v0.8.0 or the upcoming v0.9.0.
|
||||
For details of what has been added and what does not yet work,
|
||||
see the following sections.
|
||||
|
||||
Please see the [quickstart guide](../quickstart.md) for details on how to try out Confidential
|
||||
Containers.
|
||||
|
||||
Please refer to our [Acronyms](https://github.com/confidential-containers/documentation/wiki/Acronyms)
|
||||
and [Glossary](https://github.com/confidential-containers/documentation/wiki/Glossary) pages for
|
||||
definitions of the acronyms used in this document.
|
||||
|
||||
## What's new
|
||||
|
||||
* Cloud API Adaptor (peer pods) is included in the release and based on Kata main.
|
||||
* Image pulling inside the guest via the nydus snapshotter is more stable.
|
||||
* Platform support has been partially restored.
|
||||
* Confidential runtime classes ship with filesystem sharing disabled by default.
|
||||
* `kata-qemu-coco-dev` runtime class introduced for nontee development.
|
||||
* Several improvements to guest policy
|
||||
* `guest_components_procs` option introduced to control which guest components are started.
|
||||
|
||||
## Hardware Support
|
||||
|
||||
This release tentatively supports multiple TEE platforms, although
|
||||
not all features are enabled for all platforms and test coverage
|
||||
is limited.
|
||||
|
||||
## Limitations
|
||||
|
||||
The following are known limitations of this release:
|
||||
|
||||
* Encrypted images and signed images are not yet supported.
|
||||
* Sealed secrets and encrypted volumes are not yet supported.
|
||||
* SEV(-ES) and SEV-SNP do not support attestation.
|
||||
* Authenticated registries are not supported.
|
||||
* Nydus snapshotter support is not mature.
|
||||
* Nydus snapshotter sometimes fails to pull an image.
|
||||
* Nydus snapshotter cannot handle pods with init containers.
|
||||
* Host pulling with Nydus snapshotter is not yet enabled.
|
||||
* Nydus snapshotter is not supported with enclave-cc.
|
||||
* Pulling container images inside guest may have negative performance implications including greater resource usage and slower startup.
|
||||
* `crio` support is still evolving.
|
||||
* Platform support is rapidly changing
|
||||
* SELinux is not supported on the host and must be set to permissive if in use.
|
||||
* Complete integration with Kubernetes is still in progress.
|
||||
* OpenShift support is not yet complete.
|
||||
* Existing APIs do not fully support the CoCo security and threat model. [More info](https://github.com/confidential-containers/community/issues/53)
|
||||
* Some commands accessing confidential data, such as `kubectl exec`, may either fail to work, or incorrectly expose information to the host
|
||||
* The CoCo community aspires to adopting open source security best practices, but not all practices are adopted yet.
|
||||
* We track our status with the OpenSSF Best Practices Badge, which remained at 75% at the time of this release.
|
||||
* Community has adopted a security reporting protocol, but application and documentation of static and dynamic analysis still needed.
|
||||
* Container metadata such as environment variables are not measured.
|
||||
* The Kata Agent allows the host to call several dangerous endpoints
|
||||
* Kata Agent does not validate mount requests. A malicious host might be able to mount a shared filesystem into the PodVM.
|
||||
* Policy can be used to block endpoints, but it is not yet tied to the hardware evidence.
|
||||
|
||||
## CVE Fixes
|
||||
|
||||
None
|
||||
|
Reference in New Issue
Block a user