djpbessems
/
ContainerImage.Pinniped
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #141 from danjahner/main 

Minor docs updates
This commit is contained in:
Ryan Richard 2020-10-02 17:20:44 -07:00 committed by GitHub
parent 916db74d65 13e0b272c0
commit 8a360fe08e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 34 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
deploy-local-user-authenticator/README.md
View File

@ -15,7 +15,7 @@ User accounts can be created and edited dynamically using `kubectl` commands (se
## Installing the Latest Version with Default Options ## Installing the Latest Version with Default Options
```bash ```bash
kubectl apply -f https://github.com/vmware-tanzu/pinniped/releases/download/$(curl https://api.github.com/repos/vmware-tanzu/pinniped/releases/latest -s | jq .name -r)/install-local-user-authenticator.yaml kubectl apply -f https://github.com/vmware-tanzu/pinniped/releases/latest/download/install-local-user-authenticator.yaml
``` ```
## Installing an Older Version with Default Options ## Installing an Older Version with Default Options
@ -50,11 +50,11 @@ Either [install `ytt`](https://get-ytt.io/) or use the [container image from Doc
Use `kubectl` to create, edit, and delete user accounts by creating a `Secret` for each user account in the same Use `kubectl` to create, edit, and delete user accounts by creating a `Secret` for each user account in the same
namespace where local-user-authenticator is deployed. The name of the `Secret` resource is the username. namespace where local-user-authenticator is deployed. The name of the `Secret` resource is the username.
Store the user's group membership and `bcrypt` encrypted password as the contents of the `Secret`. Store the user's group membership and `bcrypt` encrypted password as the contents of the `Secret`.
For example, to create a user named `ryan` with the password `password123` For example, to create a user named `pinny-the-seal` with the password `password123`
who belongs to the groups `group1` and `group2`, use: who belongs to the groups `group1` and `group2`, use:
```bash ```bash
kubectl create secret generic ryan \ kubectl create secret generic pinny-the-seal \
--namespace local-user-authenticator \ --namespace local-user-authenticator \
--from-literal=groups=group1,group2 \ --from-literal=groups=group1,group2 \
--from-literal=passwordHash=$(htpasswd -nbBC 10 x password123 | sed -e "s/^x://") --from-literal=passwordHash=$(htpasswd -nbBC 10 x password123 | sed -e "s/^x://")
@ -109,7 +109,7 @@ is configured as an identity provider for Pinniped.
"apiVersion": "authentication.k8s.io/v1beta1", "apiVersion": "authentication.k8s.io/v1beta1",
"kind": "TokenReview", "kind": "TokenReview",
"spec": { "spec": {
"token": "ryan:password123" "token": "pinny-the-seal:password123"
} }
}' }'
``` ```
@ -118,14 +118,42 @@ is configured as an identity provider for Pinniped.
Note that the value of `authenticated` is `true` to indicate a successful authentication. Note that the value of `authenticated` is `true` to indicate a successful authentication.
```json ```json
{"apiVersion":"authentication.k8s.io/v1beta1","kind":"TokenReview","status":{"authenticated":true,"user":{"username":"ryan","uid":"19c433ec-8f58-44ca-9ef0-2d1081ccb876","groups":["group1","group2"]}}} {
"kind": "TokenReview",
"apiVersion": "authentication.k8s.io/v1beta1",
"metadata": {
"creationTimestamp": null
},
"spec": {},
"status": {
"authenticated": true,
"user": {
"username": "pinny-the-seal",
"uid": "19c433ec-8f58-44ca-9ef0-2d1081ccb876",
"groups": [
"group1",
"group2"
]
}
}
}
``` ```
Trying the above `curl` command again with the wrong username or password in the body of the request Trying the above `curl` command again with the wrong username or password in the body of the request
should result in a JSON response which indicates that the authentication failed. should result in a JSON response which indicates that the authentication failed.
```json ```json
{"apiVersion":"authentication.k8s.io/v1beta1","kind":"TokenReview","status":{"authenticated":false}} {
"kind": "TokenReview",
"apiVersion": "authentication.k8s.io/v1beta1",
"metadata": {
"creationTimestamp": null
},
"spec": {},
"status": {
"user": {}
}
}
``` ```
1. Remove the curl pod. 1. Remove the curl pod.