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.
354 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%
Go to file
Andrew Keesler b506ac5823
Port integration test setup script from CI repo 
I also started updating the script to deploy the test-webhook instead of
doing TMC stuff. I think the script should live in this repo so that
Pinniped contributors only need to worry about one repo for running
integration tests.

There are a bunch of TODOs in the script, but I figured this was a good
checkpoint. The script successfully runs on my machine and sets up the
test-webhook and pinniped on a local kind cluster. The integration tests
are failing because of some issue with pinniped talking to the test-webhook,
but this is step in the right direction.

Signed-off-by: Andrew Keesler <akeesler@vmware.com>
 		2020-09-10 11:30:15 -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 Create a deployment for `test-webhook` 2020-09-09 19:06:39 -07:00
deploy deploy/README.md: fix markdown link to test webhook README.md 2020-09-10 09:33:46 -04:00
deploy-test-webhook deploy-test-webhook/README.md: add another tool needed for the demo 2020-09-10 09:50:17 -04:00
doc Update precommit hook config to ignore generated files and fix whitespace. 2020-08-31 16:41:22 -05:00
generated Generate CRD YAML using controller-tools, update doc strings. 2020-08-31 16:38:48 -05:00
hack Port integration test setup script from CI repo 2020-09-10 11:30:15 -04:00
internal Prefactor: Move updating of APIService to a separate controller 2020-09-08 16:36:49 -07:00
pkg/config Use same lifetime for serving cert and CA cert 2020-08-27 15:59:47 -04:00
test Port integration test setup script from CI repo 2020-09-10 11:30:15 -04: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 Create a deployment for `test-webhook` 2020-09-09 19:06:39 -07:00
LICENSE Add Apache 2.0 license. 2020-07-06 13:50:31 -05:00
README.md Update precommit hook config to ignore generated files and fix whitespace. 2020-08-31 16:41:22 -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 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.

Supported Identity Provider Types

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

Supported Cluster Integration Strategies

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

  1. Pinniped hosts a credential exchange API endpoint 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 issue short-lived certificates, then the Pinniped credential exchange API will use that instead of using the cluster's signing keypair.)

kubectl Integration

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 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.