diff --git a/README.md b/README.md index 05b676d..bef6b77 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ # Project Roven -Project Roven is a set of hybrid [node attestors](https://spiffe.io/docs/latest/spire-about/spire-concepts/#node-attestation) for [SPIRE](https://github.com/spiffe/spire). +Project Roven is a set of hybrid external [node attestors](https://spiffe.io/docs/latest/spire-about/spire-concepts/#node-attestation) for [SPIRE](https://github.com/spiffe/spire). -## k8s_psat_tpm_devid +## Kubernetes PSAT + TPM Device ID Node Attestor -[`k8s_psat_tpm_devid`](k8s_psat_tpm_devid/README.md) is a hybrid, external node attestor plugin for SPIRE, and it combines the power of two built in plugins: `k8s_psat` and `tpm_devid`. \ No newline at end of file +[`k8s_psat_tpm_devid`](k8s_psat_tpm_devid/README.md) is a hybrid, external node attestor plugin for SPIRE, and it combines the power of two built in plugins: [`k8s_psat`](https://github.com/spiffe/spire/blob/main/doc/plugin_server_nodeattestor_k8s_psat.md) and [`tpm_devid`](https://github.com/spiffe/spire/blob/main/doc/plugin_server_nodeattestor_tpm_devid.md). + +## Hybrid Node Attestor + +[`hybrid`](hybrid/README.md) node attestor plugin for SPIRE is an external plugin, that combines the power of most of the built-in plugin supported by SPIRE. With this approach you can use any combination of the built-in supported plugins in order to attest the node. For example, you can mix the k8s_psat and the aws_iid plugins to attest that the agent node is running on an AWS EKS or an EC2 instance with a self managed k8s cluster. diff --git a/hybrid/README.md b/hybrid/README.md index f6fd086..b1a97d0 100644 --- a/hybrid/README.md +++ b/hybrid/README.md @@ -1,7 +1,7 @@ [![PR Build](https://github.com/HewlettPackard/roven/actions/workflows/hybrid-pr-build.yaml/badge.svg)](https://github.com/HewlettPackard/roven/actions/workflows/hybrid-pr-build.yaml) # Hybrid Node Attestor -The `hybrid` node attestor plugin for SPIRE is an external plugin, that combines the power of any built-in plugin supported by SPIRE. With this approach you can use any combination of the built-in plugins in order to attest the node. For example, you can mix the k8s_psat and the aws_iid plugins to attest that the agent node is running on an AWS EKS or an EC2 instance with a self managed k8s cluster. +The `hybrid` node attestor plugin for SPIRE is an external plugin, that combines the power of most of the built-in plugin supported by SPIRE. With this approach you can use any combination of the built-in supported plugins in order to attest the node. For example, you can mix the k8s_psat and the aws_iid plugins to attest that the agent node is running on an AWS EKS or an EC2 instance with a self managed k8s cluster. ## SpiffeID The hybrid plugin will always return the SpiffeID generated by the first plugin of the list supplied to the server. diff --git a/hybrid_node_attestor/README.md b/hybrid_node_attestor/README.md deleted file mode 100644 index 5f9e908..0000000 --- a/hybrid_node_attestor/README.md +++ /dev/null @@ -1 +0,0 @@ -# Hybrid Node Attestor