diff --git a/README.md b/README.md index 369fe970..ae5de68e 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,14 @@ This is a kubectl plugin for [Kubernetes OpenID Connect (OIDC) authentication](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#openid-connect-tokens), also known as `kubectl oidc-login`. -This is designed to run as a [client-go credential plugin](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins). +Here is an example of Kubernetes authentication with the Google Identity Platform: + +screencast + +Kubelogin is designed to run as a [client-go credential plugin](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins). When you run kubectl, kubelogin opens the browser and you can log in to the provider. Then kubelogin gets a token from the provider and kubectl access Kubernetes APIs with the token. -Take a look at the following diagram: +Take a look at the diagram: ![Diagram of the credential plugin](docs/credential-plugin-diagram.svg)