Skip to content

Commit 60dd615

Browse files
committed
Update README.md and add THIRD-PARTY-LICENSES.txt.
Signed-off-by: Erdem Meydanli <meydanli@amazon.com>
1 parent b18cafd commit 60dd615

File tree

2 files changed

+825
-7
lines changed

2 files changed

+825
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
# Introduction
22

3-
This device plugin enables the use of [Nitro Enclaves](https://aws.amazon.com/ec2/nitro/nitro-enclaves/)
4-
in your [EKS](https://aws.amazon.com/eks/) cluster.
3+
This [Kubernetes](https://kubernetes.io/) [device plugin](https://kubernetes.io/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins/) gives your pods and containers ability to access [Nitro Enclaves](https://aws.amazon.com/ec2/nitro/nitro-enclaves/) [device driver](https://docs.kernel.org/virt/ne_overview.html). The device plugin works with both [Amazon EKS](https://aws.amazon.com/eks/) and self-managed Kubernetes nodes.
54

65
# Prerequisites
76
To utilize this device plugin, you will need:
87

9-
- A configured [Kubernetes](https://kubernetes.io/) cluster on [EKS](https://aws.amazon.com/eks/)
10-
- An Enclave enabled [EC2](https://aws.amazon.com/ec2/features/) worker node
8+
- A configured [Kubernetes](https://kubernetes.io/) cluster.
9+
- An Enclave enabled [EC2](https://aws.amazon.com/ec2/features/) node.
10+
11+
To build the plugin, you will need:
1112
- Docker
1213

1314
# Usage
@@ -31,10 +32,18 @@ Disabling the plugin on a particular node is possible with the command-line belo
3132
kubectl label node <node-name> aws-nitro-enclaves-k8s-dp-
3233
```
3334

34-
# Running Nitro Enclaves in an EKS Cluster
35+
# Building the Device Plugin
36+
To build the device plugin from its sources, use:
37+
38+
```
39+
./scripts/build.sh
40+
````
41+
42+
After successful execution of the script, the device plugin will be built as a docker image with the name `aws-nitro-enclaves-k8s-device-plugin`.
43+
44+
# Running Nitro Enclaves in a Kubernetes Cluster
3545
36-
There is a hands-on guide available on how to run Nitro Enclaves in EKS clusters. Please check this [link](https://github.com/aws/aws-nitro-enclaves-with-k8s) to
37-
learn more.
46+
There is a hands-on guide available on how to run Nitro Enclaves in EKS clusters. Please check this [link](https://github.com/aws/aws-nitro-enclaves-with-k8s) to learn more.
3847
3948
# License
4049
This project is licensed under the Apache-2.0 License.

0 commit comments

Comments
 (0)