Pinniped is the easy, secure way to log in to your Kubernetes clusters.
Go to file
Andrew Keesler 1af06bbcc9
De-dup markdown docs by deleting them in site/ tree
I'm not sure if these docs are used anywhere in our website, but I don't think
that they are. I'm assuming someone or something will yell if these should not
be deleted. These docs also live at the root of the repo, and the duplicate
versions are already drifting out of sync from one another.

Signed-off-by: Andrew Keesler <akeesler@vmware.com>
2020-12-18 08:11:14 -05:00
.github Get rid of WIP workflow 2020-10-27 18:39:19 -04:00
apis Rename off of main 2020-12-16 14:27:09 -08:00
cmd Only set single secret status field in FederationDomainSecretsController 2020-12-17 07:41:53 -05:00
deploy Rename off of main 2020-12-16 14:27:09 -08:00
generated Rename off of main 2020-12-16 14:27:09 -08:00
hack Enable cache mutation detector in unit tests 2020-12-17 08:38:15 -06:00
internal Clean this test up a trivial amount using `require.Implementsf()`. 2020-12-17 08:38:16 -06:00
pkg Rename the "pinniped.sts.unrestricted" scope to "pinniped:request-audience". 2020-12-16 14:24:13 -06:00
site De-dup markdown docs by deleting them in site/ tree 2020-12-18 08:11:14 -05:00
test supervisor_login_test.go: wait for the `/jwks.json` endpoint to be ready 2020-12-16 17:59:39 -08:00
tools Save 2 lines by using inline-style comments for Copyright 2020-09-16 10:35:19 -04:00
.gitattributes Add .gitattributes as a hint to the GitHub diff viewer. 2020-09-15 11:44:23 -05:00
.gitignore Add Tilt-based local dev workflow. 2020-10-05 16:34:33 -05:00
.golangci.yaml Disable the goerr113 linter. 2020-12-07 15:53:41 -06:00
.pre-commit-config.yaml Add Tilt-based local dev workflow. 2020-10-05 16:34:33 -05:00
ADOPTERS.md Update module/package names to match GitHub org switch. 2020-09-17 12:56:54 -05:00
CODE_OF_CONDUCT.md Rename the CoC and contributor guide to the names GitHub recognizes. 2020-10-02 15:53:48 -05:00
CONTRIBUTING.md CONTRIBUTING.md: add missing integration test dependencies 2020-12-17 13:59:23 -05:00
Dockerfile Upgrade base images to Debian 10.7-slim. 2020-12-16 15:16:31 -06:00
LICENSE Add Apache 2.0 license. 2020-07-06 13:50:31 -05:00
MAINTAINERS.md Add Margo and Mo as maintainers of Pinniped 2020-12-17 13:37:20 -05:00
README.md README.md: first draft of Supervisor additions 2020-12-17 15:36:33 -05:00
SECURITY.md Update precommit hook config to ignore generated files and fix whitespace. 2020-08-31 16:41:22 -05:00
go.mod Remove `pinniped get-kubeconfig` CLI subcommand. 2020-12-15 12:28:03 -06:00
go.sum WIP for saving authorize endpoint state into upstream state param 2020-11-10 17:58:00 -08:00

README.md

Pinniped Logo

Overview

Pinniped provides identity services to Kubernetes.

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 with IDPs, and distribution-specific integration strategies.

Example Use Cases

  • 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

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.

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 and implements different integration strategies for various Kubernetes distributions to make authentication possible.

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.

To learn more, see architecture.

Pinniped Architecture Sketch

Trying Pinniped

Care to kick the tires? It's easy to install and try Pinniped.

Discussion

Got a question, comment, or idea? Please don't hesitate to reach out via the GitHub Discussions tab at the top of this page.

Contributions

Contributions are welcome. Before contributing, please see the contributing guide.

Reporting Security Vulnerabilities

Please follow the procedure described in SECURITY.md.

License

Pinniped is open source and licensed under Apache License Version 2.0. See LICENSE.

Copyright 2020 the Pinniped contributors. All Rights Reserved.