2020-12-02 18:27:34 +00:00
< img src = "site/content/docs/img/pinniped_logo.svg" alt = "Pinniped Logo" width = "100%" / >
2020-08-09 17:04:05 +00:00
2020-08-26 14:06:21 +00:00
## Overview
Pinniped provides identity services to Kubernetes.
2020-08-27 17:14:03 +00:00
Pinniped allows cluster administrators to easily plug in external identity
2020-08-26 14:06:21 +00:00
providers (IDPs) into Kubernetes clusters. This is achieved via a uniform
install procedure across all types and origins of Kubernetes clusters,
declarative configuration via Kubernetes APIs, enterprise-grade integrations
2020-08-27 17:14:03 +00:00
with IDPs, and distribution-specific integration strategies.
2020-08-26 14:06:21 +00:00
2020-08-27 17:14:03 +00:00
### Example Use Cases
2020-08-26 14:06:21 +00:00
2020-08-27 17:14:03 +00:00
* Your team uses a large enterprise IDP, and has many clusters that they
manage. Pinniped provides:
* Seamless and robust integration with the IDP
* Easy installation across clusters of any type and origin
* A simplified login flow across all clusters
* Your team shares a single cluster. Pinniped provides:
* Simple configuration to integrate an IDP
* Individual, revocable identities
2020-08-26 14:06:21 +00:00
### Architecture
2020-12-17 20:36:33 +00:00
The Pinniped Supervisor component offers identity federation to enable a user to
access multiple clusters with a single daily login to their external IDP. The
Pinniped Supervisor supports various external [IDP
types](https://github.com/vmware-tanzu/pinniped/tree/main/generated/1.19#k8s-api-idp-supervisor-pinniped-dev-v1alpha1).
The Pinniped Concierge component offers credential exchange to enable a user to
exchange an external credential for a short-lived, cluster-specific
credential. Pinniped supports various [authentication
methods](https://github.com/vmware-tanzu/pinniped/tree/main/generated/1.19#authenticationconciergepinnipeddevv1alpha1)
and implements different integration strategies for various Kubernetes
2020-08-27 17:14:03 +00:00
distributions to make authentication possible.
2020-12-17 20:36:33 +00:00
The Pinniped Concierge can be configured to hook into the Pinniped Supervisor's
federated credentials, or it can authenticate users directly via external IDP
credentials.
2020-11-22 14:44:02 +00:00
To learn more, see [architecture ](https://pinniped.dev/docs/architecture/ ).
2020-08-27 22:11:38 +00:00
2020-12-18 23:09:50 +00:00
< img src = "site/content/docs/img/pinniped_architecture_concierge_supervisor.svg" alt = "Pinniped Architecture Sketch" width = "300px" / >
2020-08-26 14:06:21 +00:00
2020-09-15 19:10:20 +00:00
## Trying Pinniped
2020-11-22 14:44:02 +00:00
Care to kick the tires? It's easy to [install and try Pinniped ](https://pinniped.dev/docs/demo/ ).
2020-09-15 19:10:20 +00:00
2020-09-29 23:46:18 +00:00
## Discussion
Got a question, comment, or idea? Please don't hesitate to reach out via the GitHub [Discussions ](https://github.com/vmware-tanzu/pinniped/discussions ) tab at the top of this page.
2020-08-27 17:14:03 +00:00
## Contributions
2020-08-26 14:06:21 +00:00
2020-10-02 20:00:23 +00:00
Contributions are welcome. Before contributing, please see the [contributing guide ](CONTRIBUTING.md ).
2020-08-20 17:54:15 +00:00
2020-08-27 22:02:11 +00:00
## Reporting Security Vulnerabilities
Please follow the procedure described in [SECURITY.md ](SECURITY.md ).
2020-08-27 12:39:20 +00:00
## License
2020-08-20 17:54:15 +00:00
2020-09-25 00:55:53 +00:00
Pinniped is open source and licensed under Apache License Version 2.0. See [LICENSE ](LICENSE ).
2020-08-20 17:54:15 +00:00
2020-09-16 14:05:51 +00:00
Copyright 2020 the Pinniped contributors. All Rights Reserved.
