Skip to content

Latest commit

 

History

History
134 lines (92 loc) · 4.21 KB

README.md

File metadata and controls

134 lines (92 loc) · 4.21 KB
Raw

dexter

Build Status

dexter is a OIDC (OpenId Connect) helper to create a hassle-free Kubernetes login experience powered by Google as Identity Provider. All you need is a properly configured Google client ID & secret.

Authentication Flow

dexter will open a new browser window and redirect you to Google. The only interaction you have is the login at Google and your k8s config is updated automatically.

dexter flow

See dexter in action

dexter in action

Configure Google credentials

Installation

You can download a prebuilt version from the Github release section or build it yourself:

go get -u github.com/gini/dexter
cd $GOPATH/src/github.com/gini/dexter

# Linux
OS=linux make

# MacOS
OS=darwin make

It is possible to embed your Google credentials into the resulting binary.

CLIENT_ID=abc123.apps.googleusercontent.com CLIENT_SECRET=mySecret OS=linux make

Run dexter

Run dexter without a command to access the help screen/intro.

❯ ./build/dexter_darwin_amd64
    .___               __
  __| _/____ ___  ____/  |_  ___________
 / __ |/ __ \\  \/  /\   __\/ __ \_  __ \
/ /_/ \  ___/ >    <  |  | \  ___/|  | \/
\____ |\___  >__/\_ \ |__|  \___  >__|
     \/    \/      \/           \/

dexter is a authentication helper for Kubernetes that does the heavy
lifting for SSO (Single Sign On) for Kubernetes.

Usage:
  dexter [command]

Available Commands:
  auth        Authenticate with OIDC provider
  help        Help about any command
  version     Print the version number of dexter

Flags:
  -h, --help      help for dexter
  -v, --verbose   verbose output

Use "dexter [command] --help" for more information about a command.

Running dexter auth will start the authentication process.

 ❯ ./build/dexter_darwin_amd64 auth --help
Use your Google login to get a JWT (JSON Web Token) and update your
local k8s config accordingly. A refresh token is added and automatically refreshed
by kubectl. Existing token configurations are overwritten.
For details go to: https://blog.gini.net/

dexters authentication flow
===========================

1. Open a browser window/tab and redirect you to Google (https://accounts.google.com)
2. You login with your Google credentials
3. You will be redirected to dexters builtin webserver and can now close the browser tab
4. dexter extracts the token from the callback and patches your ~/.kube/config

➜ Unless you have a good reason to do so please use the built-in google credentials (if they were added at build time)!

Usage:
  dexter auth [flags]

Flags:
  -c, --callback string        Callback URL. The listen address is dreived from that. (default "http://127.0.0.1:64464/callback")
  -i, --client-id string       Google clientID (default "REDACTED")
  -s, --client-secret string   Google clientSecret (default "REDACTED")
  -d, --dry-run                Toggle config overwrite
  -k, --kube-config            Define the Kubeconfig to edit
  -h, --help                   help for auth

Global Flags:
  -v, --verbose   verbose output

Contribution Guidelines

It's awesome that you consider contributing to dexter and it's really simple. Here's how it's done:

  • fork repository on Github
  • create a topic/feature branch
  • push your changes
  • update documentation if necessary
  • open a pull request

Authors

Initial code was written by Daniel Kerwin & David González Ruiz

Acknowledgements

dexter was inspired by this blog post series by Joel Speed, Micah Hausler's k8s-oidc-helper & CoreOS dex.

License

MIT License. See License for full text.