Skip to content

Commit

Permalink
Adding Documentation to the README
Browse files Browse the repository at this point in the history
**Why:**

* Documenting an example role that can be applied

Signed-off-by: Christopher Hein <[email protected]>
  • Loading branch information
christopherhein committed Aug 7, 2018
1 parent f0b3d2e commit 7cd562b
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,11 @@ This means the `kubeconfig` is entirely public data and can be shared across all
It may make sense to upload it to a trusted public location such as AWS S3.

Make sure you have the `aws-iam-authenticator` binary installed.
You can install it with `go get -u -v github.com/kubernetes-sigs/aws-iam-authenticator/cmd/aws-iam-authenticator`.
You can install it with:

```sh
go get -u -v github.com/kubernetes-sigs/aws-iam-authenticator/cmd/aws-iam-authenticator
```

To authenticate, run `kubectl --kubeconfig /path/to/kubeconfig" [...]`.
kubectl will `exec` the `aws-iam-authenticator` binary with the supplied params in your kubeconfig which will generate a token and pass it to the apiserver.
Expand Down Expand Up @@ -343,3 +347,23 @@ server:
- "456789012345"

```

## Alpha CRD Implementation

The above will allow you to manage both the server and the client using the same
configuation. If you'd like to use the alpha Custom Resource Definition setup
for the server side role mappings you can define a user or a role using the
below manifest.

```yaml
---
apiVersion: authenticator.aws/v1alpha1
kind: IAMIdentityMapping
metadata:
name: kubernetes-admin
spec:
arn: arn:aws:iam::00000000000:role/KubernetesAdmin
username: kubernetes-admin
groups:
- system:masters
```

0 comments on commit 7cd562b

Please sign in to comment.