-
Notifications
You must be signed in to change notification settings - Fork 8
Add design for the boostrap phase #154
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
alicefr
wants to merge
1
commit into
trusted-execution-clusters:main
Choose a base branch
from
alicefr:design-bootstrap
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| # Bootstrap Phase Design | ||
|
|
||
| ## Overview | ||
|
|
||
| This document describes the bootstrap phase for Trusted Execution Clusters, specifically addressing the challenge of bringing up the first control plane nodes in a confidential computing environment. | ||
|
|
||
| ## Problem Statement | ||
|
|
||
| In a standard Trusted Execution Cluster deployment, the operator and Trustee server run within the cluster itself. However, during the bootstrap phase: | ||
|
|
||
| 1. **No Control Plane Yet**: The cluster being provisioned has no running control plane to host the operator or Trustee | ||
| 1. **Attestation Required**: The first control plane nodes still require attestation to ensure they meet security requirements before being trusted | ||
| 1. **Key Management**: LUKS encryption keys for the bootstrap nodes must be registered and accessible during initial provisioning | ||
| 1. **Policy Enforcement**: Attestation and resource policies must be in place before the first nodes attempt attestation | ||
|
|
||
| ## External Trustee and Operator | ||
|
|
||
| The bootstrap phase requires an **external trusted Kubernetes cluster** that serves as the trust anchor for provisioning the new confidential cluster. This external cluster hosts the operator and Trustee infrastructure during the bootstrap phase. | ||
|
|
||
| ### Architecture Overview | ||
|
|
||
|  | ||
|
|
||
| ## Bootstrap phase | ||
|
|
||
| Before beginning the bootstrap phase, the cluster administrator must: | ||
|
|
||
| 1. **Establish External Trusted Cluster**: Deploy or identify an existing Kubernetes cluster that will serve as the trust anchor | ||
| - This cluster must be considered trusted and secure | ||
| - Must be accessible from the network where new cluster nodes will be provisioned | ||
|
|
||
| 2. **Deploy Operator on External Cluster**: Install the Trusted Execution Cluster Operator on the external cluster | ||
| - Configure it to manage resources for the new cluster being bootstrapped | ||
|
|
||
| 3. **Configure Network Accessibility**: Ensure the following endpoints are reachable from the new cluster's network | ||
| - **Registration Service**: Must be accessible by nodes during firstboot for Ignition merge | ||
| - **Attestation Key Registration**: Required for TPM-based attestation key registration | ||
| - **KBS Endpoints**: Required for attestation and key retrieval during both firstboot and subsequent boots | ||
|
|
||
| 4. **Approve Bootstrap Images**: Create ApprovedImage resources for the bootable images that will be used for bootstrap nodes | ||
| - Ensure reference values are computed and registered with Trustee | ||
| - Verify attestation policies are in place | ||
|
|
||
|
|
||
| ## Installation of new cluster | ||
|
|
||
| The new cluster nodes needs to have the ability to attest themselves against the external attestation server. Hence, they need to be configured to register and fetch their ignition configuration with the clevis pin and UUID. For more details reference the [design document for the boot phase](https://github.com/trusted-execution-clusters/operator/blob/main/docs/design/boot-attestation.md). | ||
|
|
||
| Therefore, for the initial Ignition configuration, their ignition needs to include a merge directive to the external registratio API | ||
|
|
||
| ```json | ||
|
|
||
| { | ||
| "ignition": { | ||
| "config": { | ||
| "merge": [ | ||
| { | ||
| "source": "http://<registration-service>/ignition" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| During the installation, the nodes will recieved the Ignition configuration with the clevis pin and the list of servers for the attestation. | ||
|
|
||
| ## Migration of the operator in cluster | ||
|
|
||
| Once the cluster has finished the boostrap phase, the Trusted Execution Cluster operator will be deployed in the boostrapped cluster and can start to attest the new upcoming node. | ||
|
|
||
| The objects, such as Secrets, Machines, ApprovedImages and AttestationKeys, created during in the boostrap phase need to be mirrored or transfered in the new cluster since the freshly deployed operator needs to have the global vision of the cluster and take over the attestation from the external operator. For example, if one of the initial control plane reboot needs to be able to attest using the attestation endpoint in-cluster. | ||
|
|
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the external cluster attesting only the control plane or also the compute nodes specified at install time?
In either case, how do we pivot after installation from using the external cluster to using the in-cluster operator? Specifically, we need to update the ignition stubs to point to the operator rather than the external cluster.
I can help iron out these details.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not quite sure about this. I hope there is a moment where we can detect that the bootstrap phase has finished and that we can migrate the object in cluster. I think there might be 2 approaches:
@patrickdillon if you could help identify when this "pivot" phas happen , it will be great!