Skip to content

Commit cac6837

Browse files
authored
chore: update docmentation (#9)
* chore: update docmentation Signed-off-by: Chris Butler <chris.butler@redhat.com> * chore: extra documentation Signed-off-by: Chris Butler <chris.butler@redhat.com> --------- Signed-off-by: Chris Butler <chris.butler@redhat.com>
1 parent bf89025 commit cac6837

2 files changed

Lines changed: 28 additions & 3 deletions

File tree

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,22 @@
11
# trustee
22

3-
![Version: 0.0.1](https://img.shields.io/badge/Version-0.0.1-informational?style=flat-square)
3+
![Version: 0.0.4](https://img.shields.io/badge/Version-0.0.4-informational?style=flat-square)
44

55
A Helm chart to provide an opinionated deployment of Trustee in a validated pattern
66

7-
This chart is used to serve as the template for Validated Patterns Charts
7+
This chart is intended for use with the [coco-pattern](https://github.com/validatedpatterns/coco-pattern) and other validated patterns.
8+
9+
It is part of three charts that are intended to be used together:
10+
1. [trustee](https://github.com/validatedpatterns/trustee-chart) indended to deploy the Key Broker Service (KBS) and related infrastructure (this chart))
11+
1. This should be deployed on an ACM hub cluster
12+
2. [sandboxed-containers](https://github.com/validatedpatterns/sandboxed-containers-chart) intended to be deployed on an ACM spoke cluster where there is access to confidential hardware
13+
3. [sandboxed-policies](https://github.com/validatedpatterns/sandboxed-policies-chart) intended to be deployed on an ACM hub cluster which pushes polices to the spoke cluster.
14+
15+
In order to use this chart, you will need to:
16+
1. Have a security policy created and available. This is a container security policy that will be used to verify the inside a kata vm.
17+
1. See here for more information: https://docs.redhat.com/en/documentation/openshift_sandboxed_containers/1.10/html/deploying_red_hat_build_of_trustee/deploying-trustee_azure-trustee#creating-image-verification-policy_azure-trustee
18+
2. Have a public key created and available. This is a public key that will be used to authenticate the KBS management API.
19+
3. Have a list of secret resources to be added to the KBS as a list of name, key pairs where key is the path to the secret in the secret store. These will be used to authenticate the KBS management API.
820

921
### Notable changes
1022

README.md.gotmpl

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,20 @@
55

66
{{ template "chart.description" . }}
77

8-
This chart is used to serve as the template for Validated Patterns Charts
8+
This chart is intended for use with the [coco-pattern](https://github.com/validatedpatterns/coco-pattern) and other validated patterns.
9+
10+
It is part of three charts that are intended to be used together:
11+
1. [trustee](https://github.com/validatedpatterns/trustee-chart) indended to deploy the Key Broker Service (KBS) and related infrastructure (this chart))
12+
1. This should be deployed on an ACM hub cluster
13+
2. [sandboxed-containers](https://github.com/validatedpatterns/sandboxed-containers-chart) intended to be deployed on an ACM spoke cluster where there is access to confidential hardware
14+
3. [sandboxed-policies](https://github.com/validatedpatterns/sandboxed-policies-chart) intended to be deployed on an ACM hub cluster which pushes polices to the spoke cluster.
15+
16+
In order to use this chart, you will need to:
17+
1. Have a security policy created and available. This is a container security policy that will be used to verify the inside a kata vm.
18+
1. See here for more information: https://docs.redhat.com/en/documentation/openshift_sandboxed_containers/1.10/html/deploying_red_hat_build_of_trustee/deploying-trustee_azure-trustee#creating-image-verification-policy_azure-trustee
19+
2. Have a public key created and available. This is a public key that will be used to authenticate the KBS management API.
20+
3. Have a list of secret resources to be added to the KBS as a list of name, key pairs where key is the path to the secret in the secret store. These will be used to authenticate the KBS management API.
21+
922

1023
### Notable changes
1124

0 commit comments

Comments
 (0)