|
1 |
| -# `aws-spiffe-workload-helper` |
| 1 | +# AWS SPIFFE Workload Helper |
2 | 2 |
|
3 |
| -WIP!! |
| 3 | +[](https://opensource.org/licenses/Apache-2.0) |
| 4 | +[](https://github.com/spiffe/spiffe/blob/main/MATURITY.md#development) |
| 5 | + |
| 6 | +AWS SPIFFE Workload Helper is a light-weight tool intended to assist in |
| 7 | +providing a workload with credentials for AWS using its SPIFFE identity. |
| 8 | + |
| 9 | +Currently, the helper only supports authenticating to AWS using an X.509 SVID |
| 10 | +via [AWS Roles Anywhere](https://docs.aws.amazon.com/rolesanywhere/latest/userguide/introduction.html). |
| 11 | +It provides a more native experience when using SPIFFE identities compared to |
| 12 | +the [`rolesanywhere-credential-helper`](https://github.com/aws/rolesanywhere-credential-helper) |
| 13 | +released by AWS. |
| 14 | + |
| 15 | +## Usage |
| 16 | + |
| 17 | +TODO: Link to full guide on SPIFFE website for a proper "getting started" |
| 18 | + |
| 19 | +### Binary |
| 20 | + |
| 21 | +TODO: ... |
| 22 | + |
| 23 | +### Configuring AWS SDKs and CLIs |
| 24 | + |
| 25 | +TODO: ... |
| 26 | + |
| 27 | +### OCI Image |
| 28 | + |
| 29 | +The `aws-spiffe-workload-helper` is also distributed within an OCI image. This |
| 30 | +may be useful as a source of the binary if you are building your own image and |
| 31 | +require this binary within it. |
| 32 | + |
| 33 | +These images are published to the GitHub Container Registry: [ghcr.io/spiffe/aws-spiffe-workload-helper:latest](https://github.com/spiffe/aws-spiffe-workload-helper/pkgs/container/aws-spiffe-workload-helper) |
| 34 | + |
| 35 | +```dockerfile |
| 36 | +COPY --from=ghcr.io/spiffe/aws-spiffe-workload-helper:latest /ko-app/cmd /aws-spiffe-workload-helper |
| 37 | +``` |
| 38 | + |
| 39 | +## Contributing |
| 40 | + |
| 41 | +We welcome contributions to this project. If you require any assistance, please |
| 42 | +get in contact via the SPIFFE Slack. |
| 43 | + |
| 44 | +### Governance |
| 45 | + |
| 46 | +This is a ["tiny-project"](https://github.com/spiffe/spiffe/blob/main/NEW_PROJECTS.md#tiny-projects). |
| 47 | + |
| 48 | +Dispute resolution is handled via escalation to the [SPIFFE Steering Committee (SSC)](https://github.com/spiffe/spiffe/blob/main/GOVERNANCE.md#the-spiffe-steering-committee-ssc). |
0 commit comments