Pinniped is the easy, secure way to log in to your Kubernetes clusters.
Go to file
Andrew Keesler 39b66086cc
doc/architecture.md: first draft
I tried to follow the following principles.
- Use existing wordsmithing.
- Only document things that we support today.
- Grab our README.md reader's attention using a picture.
- Use "upstream" when referring to OSS and "external" when referring to
  IDP integrations.

Signed-off-by: Andrew Keesler <akeesler@vmware.com>
2020-09-14 09:54:28 -04:00
.github Simplify dependabot config now that we have fewer modules. 2020-08-27 12:16:09 -05:00
apis Generate CRD YAML using controller-tools, update doc strings. 2020-08-31 16:38:48 -05:00
cmd cmd/local-user-authenticator: go back to use TokenReview structs 2020-09-11 16:12:43 -04:00
deploy Rename `test-webhook` to `local-user-authenticator` 2020-09-10 15:20:02 -07:00
deploy-local-user-authenticator Rename `test-webhook` to `local-user-authenticator` 2020-09-10 15:20:02 -07:00
doc doc/architecture.md: first draft 2020-09-14 09:54:28 -04:00
generated Generate CRD YAML using controller-tools, update doc strings. 2020-08-31 16:38:48 -05:00
hack More integration test script updates 2020-09-11 08:43:53 -07:00
internal Fix a nil dereference crash in rest.go 2020-09-11 13:08:54 -07:00
pkg/config Use same lifetime for serving cert and CA cert 2020-08-27 15:59:47 -04:00
test Fix a nil dereference crash in rest.go 2020-09-11 13:08:54 -07:00
tools Add generated mock for loginrequest.CertIssuer interface. 2020-07-27 12:33:33 -07:00
.gitignore Hello, world! 2020-07-02 17:05:59 -07:00
.golangci.yaml Fix latent linter issues. 2020-08-06 20:42:20 -05:00
.pre-commit-config.yaml Update precommit hook config to ignore generated files and fix whitespace. 2020-08-31 16:41:22 -05:00
Dockerfile Rename `test-webhook` to `local-user-authenticator` 2020-09-10 15:20:02 -07:00
LICENSE Add Apache 2.0 license. 2020-07-06 13:50:31 -05:00
README.md doc/architecture.md: first draft 2020-09-14 09:54:28 -04:00
SECURITY.md Update precommit hook config to ignore generated files and fix whitespace. 2020-08-31 16:41:22 -05:00
go.mod cmd/test-webhook: first draft of webhook 2020-09-09 15:27:30 -04:00
go.sum Prefactor: Move updating of APIService to a separate controller 2020-09-08 16:36:49 -07:00

README.md

Pinniped

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

Pinniped offers credential exchange to enable a user to exchange an external IDP 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.md.

Example Deployment Architecture

example-deployment-architecture

Installation

Currently, Pinniped supports self-hosted clusters where the Kube Controller Manager pod is accessible from Pinniped's pods. Support for other types of Kubernetes distributions is coming soon.

To try Pinniped, see deploy/README.md.

Contributions

Contributions are welcome. Before contributing, please see the Code of Conduct and 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 file.

Copyright 2020 VMware, Inc.