Skip to content

Commit be0e16d

Browse files
committed
chore: update docmentation
Signed-off-by: Chris Butler <chris.butler@redhat.com>
1 parent bf89025 commit be0e16d

2 files changed

Lines changed: 16 additions & 3 deletions

File tree

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
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+
In order to use this chart, you will need to:
10+
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.
11+
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
12+
2. Have a public key created and available. This is a public key that will be used to authenticate the KBS management API.
13+
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.
814

915
### Notable changes
1016

README.md.gotmpl

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,14 @@
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+
In order to use this chart, you will need to:
11+
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.
12+
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
13+
2. Have a public key created and available. This is a public key that will be used to authenticate the KBS management API.
14+
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.
15+
916

1017
### Notable changes
1118

0 commit comments

Comments
 (0)