Skip to content

Commit

Permalink
docs: use Trustee name
Browse files Browse the repository at this point in the history
Fixup a few places where we talk about the KBS Cluster.
Now there is a better name for that, Trustee.

Signed-off-by: Tobin Feldman-Fitzthum <[email protected]>
  • Loading branch information
fitzthum committed Mar 25, 2024
1 parent 11bac3e commit 1070686
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fconfidential-containers%2Fkbs.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fconfidential-containers%2Fkbs?ref=badge_shield)

This repository contains tools and components for attesting confidential guests and providing secrets to them.
These components typically operate on behalf of the guest owner and interact remotely with
Collectively, these components are known as Trustee.
Trustee typically operates on behalf of the guest owner and interact remotely with
[guest components](https://github.com/confidential-containers/guest-components).

These components were developed for the Confidential Containers project, but can be used with a wide variety
Trustee was developed for the Confidential Containers project, but can be used with a wide variety
of applications and hardware platforms.

## Components
Expand All @@ -32,7 +33,7 @@ For further information, see documentation of individual components.

## Architecture

These components are flexible and can be deployed in several different configurations.
Trustee is flexible and can be deployed in several different configurations.
This figure shows one common way to deploy these components in conjunction with certain guest components.

```mermaid
Expand All @@ -42,19 +43,19 @@ flowchart LR
subgraph Guest
CDH <.-> AA
end
subgraph KBS Cluster
subgraph Trustee
AS -- verifies evidence --> KBS
RVPS -- provides reference values--> AS
end
client-tool -- configures --> KBS
```
## Deployment

There are two main ways to deploy the KBS and supporting components.
There are two main ways to deploy Trustee.

### Docker Compose

One simple way to get started with these components is with Docker compose, which can be used
One simple way to get started with Trustee is with Docker compose, which can be used
to quickly setup a cluster matching the diagram above.

Please refer to the [cluster setup guide](kbs/docs/cluster.md).
Expand All @@ -63,7 +64,7 @@ This cluster could be run inside a VM or as part of a managed service.

### Kubernetes

There are two supported ways of deploying KBS on Kubernetes.
There are two supported ways of deploying Trustee on Kubernetes.
One is via the [KBS Operator](https://github.com/confidential-containers/kbs-operator),
which deploys the KBS components. The second option is to use the KBS'
provided Kubernetes tooling [here](kbs/config/kubernetes).
Expand Down
6 changes: 3 additions & 3 deletions kbs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ flowchart LR
subgraph Guest
AA <.-> CDH
end
subgraph KBS Cluster
subgraph Trustee
AS -- validates evidence--> KBS
end
```
Expand Down Expand Up @@ -65,10 +65,10 @@ flowchart LR
subgraph Guest
CDH <.-> AA
end
subgraph KBS Cluster 1
subgraph Trustee 1
AS -- validates evidence--> KBS1
end
subgraph KBS Cluster 2
subgraph Trustee 2
KBS2
end
```
Expand Down

0 comments on commit 1070686

Please sign in to comment.