ContainerImage.Pinniped/README.md

56 lines
2.1 KiB
Markdown
Raw Normal View History

<img src="site/content/docs/img/pinniped_logo.svg" alt="Pinniped Logo" width="100%"/>
## 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
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-27 17:14:03 +00:00
### Example Use Cases
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
### Architecture
Pinniped offers credential exchange to enable a user to exchange an external IDP
2020-08-27 17:14:03 +00:00
credential for a short-lived, cluster-specific credential. Pinniped supports various
IDP types and implements different integration strategies for various Kubernetes
distributions to make authentication possible.
To learn more, see [architecture](https://pinniped.dev/docs/architecture/).
2020-08-27 22:11:38 +00:00
<img src="site/content/docs/img/pinniped_architecture.svg" alt="Pinniped Architecture Sketch" width="300px"/>
## Trying Pinniped
Care to kick the tires? It's easy to [install and try Pinniped](https://pinniped.dev/docs/demo/).
## 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
Contributions are welcome. Before contributing, please see the [contributing guide](CONTRIBUTING.md).
2020-08-20 17:54:15 +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
Pinniped is open source and licensed under Apache License Version 2.0. See [LICENSE](LICENSE).
2020-08-20 17:54:15 +00:00
Copyright 2020 the Pinniped contributors. All Rights Reserved.