djpbessems/ContainerImage.Pinniped
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Pinniped is the easy, secure way to log in to your Kubernetes clusters.
307 Commits 30 Branches 34 Tags 22 MiB
Go 97.3%
Shell 1.3%
HTML 0.5%
SCSS 0.5%
CSS 0.2%
Other 0.1%
e6dd22ffb5
Go to file
Ryan Richard e6dd22ffb5 Merge branch 'main' into readme_edits
2020-08-27 14:29:11 -07:00
.github Simplify dependabot config now that we have fewer modules. 2020-08-27 12:16:09 -05:00
apis Merge branch 'main' into self_test 2020-08-25 19:02:27 -07:00
cmd Make ./pkg/client into an internal package using the native k8s client. 2020-08-27 11:48:18 -05:00
deploy Doc updates 2020-08-27 10:14:03 -07:00
doc Doc updates 2020-08-27 10:14:03 -07:00
generated Update Kubernetes versions. 2020-08-27 13:06:05 -05:00
hack Update Kubernetes versions. 2020-08-27 13:06:05 -05:00
internal Use same lifetime for serving cert and CA cert 2020-08-27 15:59:47 -04:00
pkg/config Use same lifetime for serving cert and CA cert 2020-08-27 15:59:47 -04:00
test Make ./pkg/client into an internal package using the native k8s client. 2020-08-27 11:48:18 -05: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 Add a .pre-commit-config.yaml file. 2020-08-14 14:41:11 -05:00
Dockerfile Make ./pkg/client into an internal package using the native k8s client. 2020-08-27 11:48:18 -05:00
go.mod Update Kubernetes versions. 2020-08-27 13:06:05 -05:00
go.sum Update Kubernetes versions. 2020-08-27 13:06:05 -05:00
LICENSE Add Apache 2.0 license. 2020-07-06 13:50:31 -05:00
README.md Doc updates 2020-08-27 10:14:03 -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.

The currently supported external IDP types are outlined here. More will be added in the future.

  1. Any webhook which implements the Kubernetes TokenReview API

The currently supported cluster integration strategies are outlined here. More will be added in the future.

  1. Pinniped hosts a credential exchange API via a Kubernetes aggregated API server. This API returns a new cluster-specific credential using the cluster's signing keypair to issue short-lived cluster certificates. (In the future, when the Kubernetes CSR API provides a way to create a short-lived certificate, then the Pinniped credential exchange API will use that instead of using the cluster's signing keypair.)

With any of the above IDPs and integration strategies, kubectl commands receive the cluster-specific credential via a Kubernetes client-go credential plugin. Users may use the Pinniped CLI as the credential plugin, or they may use any proprietary CLI built with the Pinniped Go client library.

Cluster Authentication Sequence Diagram

implementation

Installation

Currently, Pinniped supports self-hosted clusters where the teh Kube Controller Manager pod is accessible to Pinniped. Support for other type 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.

License

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

Copyright 2020 VMware, Inc.