k-space/dex
Archived
10
0
Fork 0
Code Issues Pull Requests Packages Projects Activity

Merge pull request #736 from ericchiang/kubernetes-integration-readme

Browse Source 
*: add section about dex and Kubernetes to README
This commit is contained in:
Eric Chiang 2016-12-12 14:21:44 -08:00 committed by GitHub
commit c77cb86378
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -5,7 +5,7 @@
![logo](Documentation/logos/dex-horizontal-color.png) ![logo](Documentation/logos/dex-horizontal-color.png)
Dex is an OpenID Connect server that allows users to login through upstream identity providers. Clients use a standards-based OAuth2 flow to login users, while the actual authentication is performed by established user management systems such as Google, GitHub, FreeIPA, etc. Dex is an OpenID Connect server that connects to other identity providers. Clients use a standards-based OAuth2 flow to login users, while the actual authentication is performed by established user management systems such as Google, GitHub, FreeIPA, etc.
[OpenID Connect][openid-connect] is a flavor of OAuth that builds on top of OAuth2 using the JOSE standards. This allows dex to provide: [OpenID Connect][openid-connect] is a flavor of OAuth that builds on top of OAuth2 using the JOSE standards. This allows dex to provide:
@ -19,6 +19,12 @@ Standards-based token responses allows applications to interact with any OpenID
* [Kubernetes][kubernetes] * [Kubernetes][kubernetes]
* [AWS STS][aws-sts] * [AWS STS][aws-sts]
## Kubernetes + dex
Dex's main production use is as an auth-N addon in CoreOS's enterprise Kubernetes solution, [Tectonic][tectonic]. Dex runs natively on top of any Kubernetes cluster using Third Party Resources and can drive API server authentication through the OpenID Connect plugin. Clients, such as the [Tectonic Console][tectonic-console] and `kubectl`, can act on behalf users who can login to the cluster through any identity provider dex supports.
More docs for running dex as a Kubernetes authenticator can be found [here](Documentation/kubernetes.md).
## Documentation ## Documentation
* [Getting started](Documentation/getting-started.md) * [Getting started](Documentation/getting-started.md)
@ -26,6 +32,7 @@ Standards-based token responses allows applications to interact with any OpenID
* [Storage options](Documentation/storage.md) * [Storage options](Documentation/storage.md)
* [Intro to OpenID Connect](Documentation/openid-connect.md) * [Intro to OpenID Connect](Documentation/openid-connect.md)
* [gRPC API](Documentation/api.md) * [gRPC API](Documentation/api.md)
* [Using Kubernetes with dex](Documentation/kubernetes.md)
* Identity provider logins * Identity provider logins
* [LDAP](Documentation/ldap-connector.md) * [LDAP](Documentation/ldap-connector.md)
* [GitHub](Documentation/github-connector.md) * [GitHub](Documentation/github-connector.md)
@ -41,6 +48,8 @@ Standards-based token responses allows applications to interact with any OpenID
[openid-connect]: https://openid.net/connect/ [openid-connect]: https://openid.net/connect/
[kubernetes]: http://kubernetes.io/docs/admin/authentication/#openid-connect-tokens [kubernetes]: http://kubernetes.io/docs/admin/authentication/#openid-connect-tokens
[aws-sts]: https://docs.aws.amazon.com/STS/latest/APIReference/Welcome.html [aws-sts]: https://docs.aws.amazon.com/STS/latest/APIReference/Welcome.html
[tectonic]: https://tectonic.com/
[tectonic-console]: https://tectonic.com/enterprise/docs/latest/usage/index.html#tectonic-console
[go-oidc]: https://github.com/coreos/go-oidc [go-oidc]: https://github.com/coreos/go-oidc
[issues]: https://github.com/coreos/dex/issues [issues]: https://github.com/coreos/dex/issues
[dex-dev]: https://groups.google.com/forum/#!forum/dex-dev [dex-dev]: https://groups.google.com/forum/#!forum/dex-dev