From 5664bedbb34b3eda9014e553440c7e0d2b750fa9 Mon Sep 17 00:00:00 2001 From: Maximiliano Churichi Date: Thu, 10 Aug 2023 12:21:40 +0100 Subject: [PATCH 1/3] Docs cleanup Signed-off-by: Maximiliano Churichi --- README.md | 6 +++++- hybrid/README.md | 2 +- hybrid_node_attestor/README.md | 1 - 3 files changed, 6 insertions(+), 3 deletions(-) delete mode 100644 hybrid_node_attestor/README.md diff --git a/README.md b/README.md index 05b676d..6b52572 100644 --- a/README.md +++ b/README.md @@ -4,4 +4,8 @@ Project Roven is a set of hybrid [node attestors](https://spiffe.io/docs/latest/ ## k8s_psat_tpm_devid -[`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` and `tpm_devid`. + +# 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 From 2fa138e5b023ab60190dbc5cd1c4566c2720d164 Mon Sep 17 00:00:00 2001 From: Maximiliano Churichi Date: Thu, 10 Aug 2023 12:22:47 +0100 Subject: [PATCH 2/3] Docs cleanup Signed-off-by: Maximiliano Churichi --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6b52572..96d9c4f 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ 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). -## 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`. From d658079f997b8466fa167db4579f22ce0c080692 Mon Sep 17 00:00:00 2001 From: Maximiliano Churichi Date: Thu, 10 Aug 2023 12:25:22 +0100 Subject: [PATCH 3/3] More docs cleanup Signed-off-by: Maximiliano Churichi --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 96d9c4f..bef6b77 100644 --- a/README.md +++ b/README.md @@ -1,11 +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). ## 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`. +[`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 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.