Merge branch 'main' into quiet-secrets-controllers
This commit is contained in:
Ryan Richard
GitHub
commit
a7f383f610
@ -97,16 +97,19 @@ docker build .
|
|||||||
|
|
||||||
1. Install dependencies:
|
1. Install dependencies:
|
||||||
|
|
||||||
|
- [`chromedriver`](https://chromedriver.chromium.org/) (and [Chrome](https://www.google.com/chrome/))
|
||||||
|
- [`docker`](https://www.docker.com/)
|
||||||
|
- `htpasswd` (installed by default on MacOS, usually found in `apache2-utils` package for linux)
|
||||||
|
- [`kapp`](https://carvel.dev/#getting-started)
|
||||||
- [`kind`](https://kind.sigs.k8s.io/docs/user/quick-start)
|
- [`kind`](https://kind.sigs.k8s.io/docs/user/quick-start)
|
||||||
|
- [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
|
||||||
- [`tilt`](https://docs.tilt.dev/install.html)
|
- [`tilt`](https://docs.tilt.dev/install.html)
|
||||||
- [`ytt`](https://carvel.dev/#getting-started)
|
- [`ytt`](https://carvel.dev/#getting-started)
|
||||||
- [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
|
|
||||||
- [`chromedriver`](https://chromedriver.chromium.org/) (and [Chrome](https://www.google.com/chrome/))
|
|
||||||
|
|
||||||
On macOS, these tools can be installed with [Homebrew](https://brew.sh/) (assuming you have Chrome installed already):
|
On macOS, these tools can be installed with [Homebrew](https://brew.sh/) (assuming you have Chrome installed already):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
brew install kind tilt-dev/tap/tilt k14s/tap/ytt kubectl chromedriver
|
brew install kind tilt-dev/tap/tilt k14s/tap/ytt k14s/tap/kapp kubectl chromedriver && brew cask install docker
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Create a local Kubernetes cluster using `kind`:
|
1. Create a local Kubernetes cluster using `kind`:
|
||||||
|
|||||||
19
README.md
19
README.md
@ -23,14 +23,25 @@ with IDPs, and distribution-specific integration strategies.
|
|||||||
|
|
||||||
### Architecture
|
### Architecture
|
||||||
|
|
||||||
Pinniped offers credential exchange to enable a user to exchange an external IDP
|
The Pinniped Supervisor component offers identity federation to enable a user to
|
||||||
credential for a short-lived, cluster-specific credential. Pinniped supports various
|
access multiple clusters with a single daily login to their external IDP. The
|
||||||
IDP types and implements different integration strategies for various Kubernetes
|
Pinniped Supervisor supports various external [IDP
|
||||||
|
types](https://github.com/vmware-tanzu/pinniped/tree/main/generated/1.19#k8s-api-idp-supervisor-pinniped-dev-v1alpha1).
|
||||||
|
|
||||||
|
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](https://github.com/vmware-tanzu/pinniped/tree/main/generated/1.19#authenticationconciergepinnipeddevv1alpha1)
|
||||||
|
and implements different integration strategies for various Kubernetes
|
||||||
distributions to make authentication possible.
|
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](https://pinniped.dev/docs/architecture/).
|
To learn more, see [architecture](https://pinniped.dev/docs/architecture/).
|
||||||
|
|
||||||
<img src="site/content/docs/img/pinniped_architecture.svg" alt="Pinniped Architecture Sketch" width="300px"/>
|
<img src="site/content/docs/img/pinniped_architecture_concierge_supervisor.svg" alt="Pinniped Architecture Sketch" width="300px"/>
|
||||||
|
|
||||||
## Trying Pinniped
|
## Trying Pinniped
|
||||||
|
|
||||||
|
|||||||
@ -27,9 +27,12 @@ menu:
|
|||||||
- name: Overview
|
- name: Overview
|
||||||
url: /docs/
|
url: /docs/
|
||||||
weight: 100
|
weight: 100
|
||||||
|
- name: Install
|
||||||
|
url: /docs/install/
|
||||||
|
weight: 110
|
||||||
- name: Architecture
|
- name: Architecture
|
||||||
url: /docs/architecture/
|
url: /docs/architecture/
|
||||||
- name: Demo
|
- name: Demo
|
||||||
url: /docs/demo/
|
url: /docs/demo/
|
||||||
- name: Scope
|
- name: Scope
|
||||||
url: /docs/scope/
|
url: /docs/scope/
|
||||||
|
|||||||
@ -1,9 +0,0 @@
|
|||||||
# Pinniped Adopters
|
|
||||||
|
|
||||||
These organizations are using Pinniped.
|
|
||||||
|
|
||||||
* [VMware Tanzu](https://tanzu.vmware.com/) ([Tanzu Mission Control](https://tanzu.vmware.com/mission-control))
|
|
||||||
|
|
||||||
If you are using Pinniped and are not on this list, you can open a [pull
|
|
||||||
request](https://github.com/vmware-tanzu/pinniped/issues/new?template=feature-proposal.md)
|
|
||||||
to add yourself.
|
|
||||||
@ -1,84 +0,0 @@
|
|||||||
# Contributor Covenant Code of Conduct
|
|
||||||
|
|
||||||
## Our Pledge
|
|
||||||
|
|
||||||
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
|
||||||
|
|
||||||
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
|
|
||||||
|
|
||||||
## Our Standards
|
|
||||||
|
|
||||||
Examples of behavior that contributes to a positive environment for our community include:
|
|
||||||
|
|
||||||
* Demonstrating empathy and kindness toward other people
|
|
||||||
* Being respectful of differing opinions, viewpoints, and experiences
|
|
||||||
* Giving and gracefully accepting constructive feedback
|
|
||||||
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
|
|
||||||
* Focusing on what is best not just for us as individuals, but for the overall community
|
|
||||||
|
|
||||||
Examples of unacceptable behavior include:
|
|
||||||
|
|
||||||
* The use of sexualized language or imagery, and sexual attention or
|
|
||||||
advances of any kind
|
|
||||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
||||||
* Public or private harassment
|
|
||||||
* Publishing others' private information, such as a physical or email
|
|
||||||
address, without their explicit permission
|
|
||||||
* Other conduct which could reasonably be considered inappropriate in a
|
|
||||||
professional setting
|
|
||||||
|
|
||||||
## Enforcement Responsibilities
|
|
||||||
|
|
||||||
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
|
|
||||||
|
|
||||||
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
|
|
||||||
|
|
||||||
## Scope
|
|
||||||
|
|
||||||
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
|
|
||||||
|
|
||||||
## Enforcement
|
|
||||||
|
|
||||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [oss-coc@vmware.com](mailto:oss-coc@vmware.com). All complaints will be reviewed and investigated promptly and fairly.
|
|
||||||
|
|
||||||
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
|
|
||||||
|
|
||||||
## Enforcement Guidelines
|
|
||||||
|
|
||||||
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
|
|
||||||
|
|
||||||
### 1. Correction
|
|
||||||
|
|
||||||
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
|
|
||||||
|
|
||||||
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
|
|
||||||
|
|
||||||
### 2. Warning
|
|
||||||
|
|
||||||
**Community Impact**: A violation through a single incident or series of actions.
|
|
||||||
|
|
||||||
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
|
|
||||||
|
|
||||||
### 3. Temporary Ban
|
|
||||||
|
|
||||||
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
|
|
||||||
|
|
||||||
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
|
|
||||||
|
|
||||||
### 4. Permanent Ban
|
|
||||||
|
|
||||||
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
|
|
||||||
|
|
||||||
**Consequence**: A permanent ban from any sort of public interaction within the community.
|
|
||||||
|
|
||||||
## Attribution
|
|
||||||
|
|
||||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
|
|
||||||
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
|
||||||
|
|
||||||
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
|
|
||||||
|
|
||||||
[homepage]: https://www.contributor-covenant.org
|
|
||||||
|
|
||||||
For answers to common questions about this code of conduct, see the FAQ at
|
|
||||||
https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
|
|
||||||
@ -1,165 +0,0 @@
|
|||||||
# Contributing to Pinniped
|
|
||||||
|
|
||||||
Contributions to Pinniped are welcome. Here are some things to help you get started.
|
|
||||||
|
|
||||||
## Code of Conduct
|
|
||||||
|
|
||||||
Please see the [Code of Conduct](./CODE_OF_CONDUCT.md).
|
|
||||||
|
|
||||||
## Project Scope
|
|
||||||
|
|
||||||
Learn about the [scope](doc/scope.md) of the project.
|
|
||||||
|
|
||||||
## Meeting with the Maintainers
|
|
||||||
|
|
||||||
The maintainers aspire to hold a video conference every other week with the Pinniped community.
|
|
||||||
Any community member may request to add topics to the agenda by contacting a [maintainer](MAINTAINERS.md)
|
|
||||||
in advance, or by attending and raising the topic during time remaining after the agenda is covered.
|
|
||||||
Typical agenda items include topics regarding the roadmap, feature requests, bug reports, pull requests, etc.
|
|
||||||
A [public document](https://docs.google.com/document/d/1qYA35wZV-6bxcH5375vOnIGkNBo7e4OROgsV4Sj8WjQ)
|
|
||||||
tracks the agendas and notes for these meetings.
|
|
||||||
|
|
||||||
These meetings are currently scheduled for the first and third Thursday mornings of each month
|
|
||||||
at 9 AM Pacific Time, using this [Zoom meeting](https://VMware.zoom.us/j/94638309756?pwd=V3NvRXJIdDg5QVc0TUdFM2dYRzgrUT09).
|
|
||||||
If the meeting day falls on a US holiday, please consider that occurrence of the meeting to be canceled.
|
|
||||||
|
|
||||||
## 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.
|
|
||||||
|
|
||||||
## Issues
|
|
||||||
|
|
||||||
Need an idea for a project to get started contributing? Take a look at the open
|
|
||||||
[issues](https://github.com/vmware-tanzu/pinniped/issues).
|
|
||||||
Also check to see if any open issues are labeled with
|
|
||||||
["good first issue"](https://github.com/vmware-tanzu/pinniped/labels/good%20first%20issue)
|
|
||||||
or ["help wanted"](https://github.com/vmware-tanzu/pinniped/labels/help%20wanted).
|
|
||||||
|
|
||||||
### Bugs
|
|
||||||
|
|
||||||
To file a bug report, please first open an
|
|
||||||
[issue](https://github.com/vmware-tanzu/pinniped/issues/new?template=bug_report.md). The project team
|
|
||||||
will work with you on your bug report.
|
|
||||||
|
|
||||||
Once the bug has been validated, a [pull request](https://github.com/vmware-tanzu/pinniped/compare)
|
|
||||||
can be opened to fix the bug.
|
|
||||||
|
|
||||||
For specifics on what to include in your bug report, please follow the
|
|
||||||
guidelines in the issue and pull request templates.
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
To suggest a feature, please first open an
|
|
||||||
[issue](https://github.com/vmware-tanzu/pinniped/issues/new?template=feature-proposal.md)
|
|
||||||
and tag it with `proposal`, or create a new [Discussion](https://github.com/vmware-tanzu/pinniped/discussions).
|
|
||||||
The project team will work with you on your feature request.
|
|
||||||
|
|
||||||
Once the feature request has been validated, a [pull request](https://github.com/vmware-tanzu/pinniped/compare)
|
|
||||||
can be opened to implement the feature.
|
|
||||||
|
|
||||||
For specifics on what to include in your feature request, please follow the
|
|
||||||
guidelines in the issue and pull request templates.
|
|
||||||
|
|
||||||
## CLA
|
|
||||||
|
|
||||||
We welcome contributions from everyone but we can only accept them if you sign
|
|
||||||
our Contributor License Agreement (CLA). If you would like to contribute and you
|
|
||||||
have not signed it, our CLA-bot will walk you through the process when you open
|
|
||||||
a Pull Request. For questions about the CLA process, see the
|
|
||||||
[FAQ](https://cla.vmware.com/faq) or submit a question through the GitHub issue
|
|
||||||
tracker.
|
|
||||||
|
|
||||||
## Building
|
|
||||||
|
|
||||||
The [Dockerfile](Dockerfile) at the root of the repo can be used to build and
|
|
||||||
package the code. After making a change to the code, rebuild the docker image with the following command.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# From the root directory of the repo...
|
|
||||||
docker build .
|
|
||||||
```
|
|
||||||
|
|
||||||
## Testing
|
|
||||||
|
|
||||||
### Running Lint
|
|
||||||
|
|
||||||
```bash
|
|
||||||
./hack/module.sh lint
|
|
||||||
```
|
|
||||||
|
|
||||||
### Running Unit Tests
|
|
||||||
|
|
||||||
```bash
|
|
||||||
./hack/module.sh units
|
|
||||||
```
|
|
||||||
|
|
||||||
### Running Integration Tests
|
|
||||||
|
|
||||||
1. Install dependencies:
|
|
||||||
|
|
||||||
- [`kind`](https://kind.sigs.k8s.io/docs/user/quick-start)
|
|
||||||
- [`tilt`](https://docs.tilt.dev/install.html)
|
|
||||||
- [`ytt`](https://carvel.dev/#getting-started)
|
|
||||||
- [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
|
|
||||||
- [`chromedriver`](https://chromedriver.chromium.org/) (and [Chrome](https://www.google.com/chrome/))
|
|
||||||
|
|
||||||
On macOS, these tools can be installed with [Homebrew](https://brew.sh/) (assuming you have Chrome installed already):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
brew install kind tilt-dev/tap/tilt k14s/tap/ytt kubectl chromedriver
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Create a local Kubernetes cluster using `kind`:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
./hack/kind-up.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Install Pinniped and supporting dependencies using `tilt`:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
./hack/tilt-up.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
Tilt will continue running and live-updating the Pinniped deployment whenever the code changes.
|
|
||||||
|
|
||||||
1. Run the Pinniped integration tests:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
source /tmp/integration-test-env && go test -v -count 1 ./test/integration
|
|
||||||
```
|
|
||||||
|
|
||||||
To uninstall the test environment, run `./hack/tilt-down.sh`.
|
|
||||||
To destroy the local Kubernetes cluster, run `./hack/kind-down.sh`.
|
|
||||||
|
|
||||||
### Observing Tests on the Continuous Integration Environment
|
|
||||||
|
|
||||||
[CI](https://hush-house.pivotal.io/teams/tanzu-user-auth/pipelines/pinniped-pull-requests)
|
|
||||||
will not be triggered on a pull request until the pull request is reviewed and
|
|
||||||
approved for CI by a project [maintainer](MAINTAINERS.md). Once CI is triggered,
|
|
||||||
the progress and results will appear on the Github page for that
|
|
||||||
[pull request](https://github.com/vmware-tanzu/pinniped/pulls) as checks. Links
|
|
||||||
will appear to view the details of each check.
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
Any pull request which adds a new feature or changes the behavior of any feature which was previously documented
|
|
||||||
should include updates to the documentation. All documentation lives in this repository. This project aspires to
|
|
||||||
follow the Kubernetes [documentation style guide](https://kubernetes.io/docs/contribute/style/style-guide).
|
|
||||||
|
|
||||||
## Pre-commit Hooks
|
|
||||||
|
|
||||||
This project uses [pre-commit](https://pre-commit.com/) to agree on some conventions about whitespace/file encoding.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ brew install pre-commit
|
|
||||||
[...]
|
|
||||||
$ pre-commit install
|
|
||||||
pre-commit installed at .git/hooks/pre-commit
|
|
||||||
```
|
|
||||||
|
|
||||||
## Becoming a Pinniped Maintainer
|
|
||||||
|
|
||||||
Regular contributors who are active in the Pinniped community and who have contributed at least several
|
|
||||||
significant pull requests may be considered for promotion to become a maintainer upon request. Please
|
|
||||||
contact an existing [maintainer](MAINTAINERS.md) if you would like to be considered.
|
|
||||||
@ -1,202 +0,0 @@
|
|||||||
|
|
||||||
Apache License
|
|
||||||
Version 2.0, January 2004
|
|
||||||
http://www.apache.org/licenses/
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
||||||
|
|
||||||
1. Definitions.
|
|
||||||
|
|
||||||
"License" shall mean the terms and conditions for use, reproduction,
|
|
||||||
and distribution as defined by Sections 1 through 9 of this document.
|
|
||||||
|
|
||||||
"Licensor" shall mean the copyright owner or entity authorized by
|
|
||||||
the copyright owner that is granting the License.
|
|
||||||
|
|
||||||
"Legal Entity" shall mean the union of the acting entity and all
|
|
||||||
other entities that control, are controlled by, or are under common
|
|
||||||
control with that entity. For the purposes of this definition,
|
|
||||||
"control" means (i) the power, direct or indirect, to cause the
|
|
||||||
direction or management of such entity, whether by contract or
|
|
||||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
||||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
||||||
|
|
||||||
"You" (or "Your") shall mean an individual or Legal Entity
|
|
||||||
exercising permissions granted by this License.
|
|
||||||
|
|
||||||
"Source" form shall mean the preferred form for making modifications,
|
|
||||||
including but not limited to software source code, documentation
|
|
||||||
source, and configuration files.
|
|
||||||
|
|
||||||
"Object" form shall mean any form resulting from mechanical
|
|
||||||
transformation or translation of a Source form, including but
|
|
||||||
not limited to compiled object code, generated documentation,
|
|
||||||
and conversions to other media types.
|
|
||||||
|
|
||||||
"Work" shall mean the work of authorship, whether in Source or
|
|
||||||
Object form, made available under the License, as indicated by a
|
|
||||||
copyright notice that is included in or attached to the work
|
|
||||||
(an example is provided in the Appendix below).
|
|
||||||
|
|
||||||
"Derivative Works" shall mean any work, whether in Source or Object
|
|
||||||
form, that is based on (or derived from) the Work and for which the
|
|
||||||
editorial revisions, annotations, elaborations, or other modifications
|
|
||||||
represent, as a whole, an original work of authorship. For the purposes
|
|
||||||
of this License, Derivative Works shall not include works that remain
|
|
||||||
separable from, or merely link (or bind by name) to the interfaces of,
|
|
||||||
the Work and Derivative Works thereof.
|
|
||||||
|
|
||||||
"Contribution" shall mean any work of authorship, including
|
|
||||||
the original version of the Work and any modifications or additions
|
|
||||||
to that Work or Derivative Works thereof, that is intentionally
|
|
||||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
||||||
or by an individual or Legal Entity authorized to submit on behalf of
|
|
||||||
the copyright owner. For the purposes of this definition, "submitted"
|
|
||||||
means any form of electronic, verbal, or written communication sent
|
|
||||||
to the Licensor or its representatives, including but not limited to
|
|
||||||
communication on electronic mailing lists, source code control systems,
|
|
||||||
and issue tracking systems that are managed by, or on behalf of, the
|
|
||||||
Licensor for the purpose of discussing and improving the Work, but
|
|
||||||
excluding communication that is conspicuously marked or otherwise
|
|
||||||
designated in writing by the copyright owner as "Not a Contribution."
|
|
||||||
|
|
||||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
||||||
on behalf of whom a Contribution has been received by Licensor and
|
|
||||||
subsequently incorporated within the Work.
|
|
||||||
|
|
||||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
copyright license to reproduce, prepare Derivative Works of,
|
|
||||||
publicly display, publicly perform, sublicense, and distribute the
|
|
||||||
Work and such Derivative Works in Source or Object form.
|
|
||||||
|
|
||||||
3. Grant of Patent License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
(except as stated in this section) patent license to make, have made,
|
|
||||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
||||||
where such license applies only to those patent claims licensable
|
|
||||||
by such Contributor that are necessarily infringed by their
|
|
||||||
Contribution(s) alone or by combination of their Contribution(s)
|
|
||||||
with the Work to which such Contribution(s) was submitted. If You
|
|
||||||
institute patent litigation against any entity (including a
|
|
||||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
||||||
or a Contribution incorporated within the Work constitutes direct
|
|
||||||
or contributory patent infringement, then any patent licenses
|
|
||||||
granted to You under this License for that Work shall terminate
|
|
||||||
as of the date such litigation is filed.
|
|
||||||
|
|
||||||
4. Redistribution. You may reproduce and distribute copies of the
|
|
||||||
Work or Derivative Works thereof in any medium, with or without
|
|
||||||
modifications, and in Source or Object form, provided that You
|
|
||||||
meet the following conditions:
|
|
||||||
|
|
||||||
(a) You must give any other recipients of the Work or
|
|
||||||
Derivative Works a copy of this License; and
|
|
||||||
|
|
||||||
(b) You must cause any modified files to carry prominent notices
|
|
||||||
stating that You changed the files; and
|
|
||||||
|
|
||||||
(c) You must retain, in the Source form of any Derivative Works
|
|
||||||
that You distribute, all copyright, patent, trademark, and
|
|
||||||
attribution notices from the Source form of the Work,
|
|
||||||
excluding those notices that do not pertain to any part of
|
|
||||||
the Derivative Works; and
|
|
||||||
|
|
||||||
(d) If the Work includes a "NOTICE" text file as part of its
|
|
||||||
distribution, then any Derivative Works that You distribute must
|
|
||||||
include a readable copy of the attribution notices contained
|
|
||||||
within such NOTICE file, excluding those notices that do not
|
|
||||||
pertain to any part of the Derivative Works, in at least one
|
|
||||||
of the following places: within a NOTICE text file distributed
|
|
||||||
as part of the Derivative Works; within the Source form or
|
|
||||||
documentation, if provided along with the Derivative Works; or,
|
|
||||||
within a display generated by the Derivative Works, if and
|
|
||||||
wherever such third-party notices normally appear. The contents
|
|
||||||
of the NOTICE file are for informational purposes only and
|
|
||||||
do not modify the License. You may add Your own attribution
|
|
||||||
notices within Derivative Works that You distribute, alongside
|
|
||||||
or as an addendum to the NOTICE text from the Work, provided
|
|
||||||
that such additional attribution notices cannot be construed
|
|
||||||
as modifying the License.
|
|
||||||
|
|
||||||
You may add Your own copyright statement to Your modifications and
|
|
||||||
may provide additional or different license terms and conditions
|
|
||||||
for use, reproduction, or distribution of Your modifications, or
|
|
||||||
for any such Derivative Works as a whole, provided Your use,
|
|
||||||
reproduction, and distribution of the Work otherwise complies with
|
|
||||||
the conditions stated in this License.
|
|
||||||
|
|
||||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
||||||
any Contribution intentionally submitted for inclusion in the Work
|
|
||||||
by You to the Licensor shall be under the terms and conditions of
|
|
||||||
this License, without any additional terms or conditions.
|
|
||||||
Notwithstanding the above, nothing herein shall supersede or modify
|
|
||||||
the terms of any separate license agreement you may have executed
|
|
||||||
with Licensor regarding such Contributions.
|
|
||||||
|
|
||||||
6. Trademarks. This License does not grant permission to use the trade
|
|
||||||
names, trademarks, service marks, or product names of the Licensor,
|
|
||||||
except as required for reasonable and customary use in describing the
|
|
||||||
origin of the Work and reproducing the content of the NOTICE file.
|
|
||||||
|
|
||||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
||||||
agreed to in writing, Licensor provides the Work (and each
|
|
||||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
||||||
implied, including, without limitation, any warranties or conditions
|
|
||||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
||||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
||||||
appropriateness of using or redistributing the Work and assume any
|
|
||||||
risks associated with Your exercise of permissions under this License.
|
|
||||||
|
|
||||||
8. Limitation of Liability. In no event and under no legal theory,
|
|
||||||
whether in tort (including negligence), contract, or otherwise,
|
|
||||||
unless required by applicable law (such as deliberate and grossly
|
|
||||||
negligent acts) or agreed to in writing, shall any Contributor be
|
|
||||||
liable to You for damages, including any direct, indirect, special,
|
|
||||||
incidental, or consequential damages of any character arising as a
|
|
||||||
result of this License or out of the use or inability to use the
|
|
||||||
Work (including but not limited to damages for loss of goodwill,
|
|
||||||
work stoppage, computer failure or malfunction, or any and all
|
|
||||||
other commercial damages or losses), even if such Contributor
|
|
||||||
has been advised of the possibility of such damages.
|
|
||||||
|
|
||||||
9. Accepting Warranty or Additional Liability. While redistributing
|
|
||||||
the Work or Derivative Works thereof, You may choose to offer,
|
|
||||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
||||||
or other liability obligations and/or rights consistent with this
|
|
||||||
License. However, in accepting such obligations, You may act only
|
|
||||||
on Your own behalf and on Your sole responsibility, not on behalf
|
|
||||||
of any other Contributor, and only if You agree to indemnify,
|
|
||||||
defend, and hold each Contributor harmless for any liability
|
|
||||||
incurred by, or claims asserted against, such Contributor by reason
|
|
||||||
of your accepting any such warranty or additional liability.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
APPENDIX: How to apply the Apache License to your work.
|
|
||||||
|
|
||||||
To apply the Apache License to your work, attach the following
|
|
||||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
||||||
replaced with your own identifying information. (Don't include
|
|
||||||
the brackets!) The text should be enclosed in the appropriate
|
|
||||||
comment syntax for the file format. We also recommend that a
|
|
||||||
file or class name and description of purpose be included on the
|
|
||||||
same "printed page" as the copyright notice for easier
|
|
||||||
identification within third-party archives.
|
|
||||||
|
|
||||||
Copyright [yyyy] [name of copyright owner]
|
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
you may not use this file except in compliance with the License.
|
|
||||||
You may obtain a copy of the License at
|
|
||||||
|
|
||||||
http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
See the License for the specific language governing permissions and
|
|
||||||
limitations under the License.
|
|
||||||
@ -1,17 +0,0 @@
|
|||||||
# Pinniped Maintainers
|
|
||||||
|
|
||||||
This is the current list of maintainers for the Pinniped project.
|
|
||||||
|
|
||||||
| Maintainer | GitHub ID | Affiliation |
|
|
||||||
| --------------- | --------- | ----------- |
|
|
||||||
| Andrew Keesler | [ankeesler](https://github.com/ankeesler) | [VMware](https://www.github.com/vmware/) |
|
|
||||||
| Matt Moyer | [mattmoyer](https://github.com/mattmoyer) | [VMware](https://www.github.com/vmware/) |
|
|
||||||
| Pablo Schuhmacher | [pabloschuhmacher](https://github.com/pabloschuhmacher) | [VMware](https://www.github.com/vmware/) |
|
|
||||||
| Ryan Richard | [cfryanr](https://github.com/cfryanr) | [VMware](https://www.github.com/vmware/) |
|
|
||||||
|
|
||||||
## Pinniped Contributors & Stakeholders
|
|
||||||
|
|
||||||
| Feature Area | Lead |
|
|
||||||
| ----------------------------- | :---------------------: |
|
|
||||||
| Technical Lead | Matt Moyer (mattmoyer) |
|
|
||||||
| Product Management | Pablo Schuhmacher (pabloschuhmacher) |
|
|
||||||
@ -1,12 +0,0 @@
|
|||||||
# Reporting a Vulnerability
|
|
||||||
|
|
||||||
Pinniped development is sponsored by VMware, and the Pinniped team encourages users
|
|
||||||
who become aware of a security vulnerability in Pinniped to report any potential
|
|
||||||
vulnerabilities found to security@vmware.com. If possible, please include a description
|
|
||||||
of the effects of the vulnerability, reproduction steps, and a description of in which
|
|
||||||
version of Pinniped or its dependencies the vulnerability was discovered.
|
|
||||||
The use of encrypted email is encouraged. The public PGP key can be found at https://kb.vmware.com/kb/1055.
|
|
||||||
|
|
||||||
The Pinniped team hopes that users encountering a new vulnerability will contact
|
|
||||||
us privately as it is in the best interests of our users that the Pinniped team has
|
|
||||||
an opportunity to investigate and confirm a suspected vulnerability before it becomes public knowledge.
|
|
||||||
@ -10,13 +10,18 @@ The principal purpose of Pinniped is to allow users to access Kubernetes
|
|||||||
clusters. Pinniped hopes to enable this access across a wide range of Kubernetes
|
clusters. Pinniped hopes to enable this access across a wide range of Kubernetes
|
||||||
environments with zero configuration.
|
environments with zero configuration.
|
||||||
|
|
||||||
This integration is implemented using a credential exchange API which takes as
|
Pinniped is composed of two parts.
|
||||||
input a credential from the external IDP and returns a credential which is understood by the host
|
1. The Pinniped Supervisor is an OIDC server which allows users to authenticate
|
||||||
Kubernetes cluster.
|
with an external identity provider (IDP), and then issues its own federation ID tokens
|
||||||
|
to be passed on to clusters based on the user information from the IDP.
|
||||||
|
1. The Pinniped Concierge is a credential exchange API which takes as input a
|
||||||
|
credential from an identity source (e.g., Pinniped Supervisor, proprietary IDP),
|
||||||
|
authenticates the user via that credential, and returns another credential which is
|
||||||
|
understood by the host Kubernetes cluster.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Pinniped supports various IDP types and implements different integration strategies
|
Pinniped supports various authenticator types and OIDC identity providers and implements different integration strategies
|
||||||
for various Kubernetes distributions to make authentication possible.
|
for various Kubernetes distributions to make authentication possible.
|
||||||
|
|
||||||
## Supported Kubernetes Cluster Types
|
## Supported Kubernetes Cluster Types
|
||||||
@ -29,11 +34,32 @@ Support for other types of Kubernetes distributions is coming soon.
|
|||||||
|
|
||||||
## External Identity Provider Integrations
|
## External Identity Provider Integrations
|
||||||
|
|
||||||
Pinniped will consume identity from one or more external identity providers
|
The Pinniped Supervisor will federate identity from one or more IDPs.
|
||||||
(IDPs). Administrators will configure external IDPs via Kubernetes custom
|
Administrators will configure the Pinniped Supervisor to use IDPs via Kubernetes
|
||||||
|
custom resources allowing Pinniped to be managed using GitOps and standard
|
||||||
|
Kubernetes tools.
|
||||||
|
|
||||||
|
Pinniped supports the following IDPs.
|
||||||
|
|
||||||
|
1. Any [OIDC-compliant](https://openid.net/specs/openid-connect-core-1_0.html)
|
||||||
|
identity provider (e.g., [Dex](https://github.com/dexidp/dex),
|
||||||
|
[Okta](https://www.okta.com/)).
|
||||||
|
|
||||||
|
The
|
||||||
|
[`idp.supervisor.pinniped.dev`](https://github.com/vmware-tanzu/pinniped/blob/main/generated/1.19/README.adoc#k8s-api-idp-supervisor-pinniped-dev-v1alpha1)
|
||||||
|
API group contains the Kubernetes custom resources that configure the Pinniped
|
||||||
|
Supervisor's upstream IDPs.
|
||||||
|
|
||||||
|
More IDP integrations are coming soon.
|
||||||
|
|
||||||
|
## Authenticators
|
||||||
|
|
||||||
|
The Pinniped Concierge requires one or more **authenticators** to validate external credentials in order to
|
||||||
|
issue cluster specific credentials.
|
||||||
|
Administrators will configure authenticators via Kubernetes custom
|
||||||
resources allowing Pinniped to be managed using GitOps and standard Kubernetes tools.
|
resources allowing Pinniped to be managed using GitOps and standard Kubernetes tools.
|
||||||
|
|
||||||
Pinniped supports the following external IDP types.
|
Pinniped supports the following authenticator types.
|
||||||
|
|
||||||
1. Any webhook which implements the
|
1. Any webhook which implements the
|
||||||
[Kubernetes TokenReview API](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#webhook-token-authentication).
|
[Kubernetes TokenReview API](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#webhook-token-authentication).
|
||||||
@ -44,13 +70,25 @@ Pinniped supports the following external IDP types.
|
|||||||
sample implementation in Golang. See the `ServeHTTP` method of
|
sample implementation in Golang. See the `ServeHTTP` method of
|
||||||
[cmd/local-user-authenticator/main.go](https://github.com/vmware-tanzu/pinniped/blob/main/cmd/local-user-authenticator/main.go).
|
[cmd/local-user-authenticator/main.go](https://github.com/vmware-tanzu/pinniped/blob/main/cmd/local-user-authenticator/main.go).
|
||||||
|
|
||||||
More IDP types are coming soon.
|
1. A JSON Web Token (JWT) authenticator, which will validate and parse claims
|
||||||
|
from JWTs. This can be used to validate tokens that are issued by the
|
||||||
|
Pinniped Supervisor, any
|
||||||
|
[OIDC-compliant](https://openid.net/specs/openid-connect-core-1_0.html)
|
||||||
|
identity provider, or various other identity sources. The JWT authenticator
|
||||||
|
provides the same functionality as the [Kubernetes OIDC authentication
|
||||||
|
mechanism](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#openid-connect-tokens),
|
||||||
|
but it is configurable at cluster runtime instead of requiring flags to be
|
||||||
|
set on the `kube-apiserver` process.
|
||||||
|
|
||||||
|
The
|
||||||
|
[`authentication.concierge.pinniped.dev`](https://github.com/vmware-tanzu/pinniped/blob/main/generated/1.19/README.adoc#k8s-api-authentication-concierge-pinniped-dev-v1alpha1)
|
||||||
|
API group contains the Kubernetes custom resources that configure the Pinniped
|
||||||
|
Concierge's authenticators.
|
||||||
|
|
||||||
## Cluster Integration Strategies
|
## Cluster Integration Strategies
|
||||||
|
|
||||||
Pinniped will issue a cluster credential by leveraging cluster-specific
|
Pinniped will issue a cluster credential by leveraging cluster-specific
|
||||||
functionality. In the near term, cluster integrations will happen via different
|
functionality. In the longer term,
|
||||||
cluster-specific flows depending on the type of cluster. In the longer term,
|
|
||||||
Pinniped hopes to contribute and leverage upstream Kubernetes extension points that
|
Pinniped hopes to contribute and leverage upstream Kubernetes extension points that
|
||||||
cleanly enable this integration.
|
cleanly enable this integration.
|
||||||
|
|
||||||
@ -67,15 +105,65 @@ support more Kubernetes cluster types.
|
|||||||
|
|
||||||
## kubectl Integration
|
## kubectl Integration
|
||||||
|
|
||||||
With any of the above IDPs and integration strategies, `kubectl` commands receive the
|
With any of the above IDPs, authentication methods, and cluster integration strategies, `kubectl` commands receive the
|
||||||
cluster-specific credential via a
|
cluster-specific credential via a
|
||||||
[Kubernetes client-go credential plugin](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins).
|
[Kubernetes client-go credential plugin](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins).
|
||||||
Users may use the Pinniped CLI as the credential plugin, or they may use any proprietary CLI
|
Users may use the Pinniped CLI as the credential plugin, or they may use any proprietary CLI
|
||||||
built with the [Pinniped Go client library](https://github.com/vmware-tanzu/pinniped/tree/main/generated).
|
built with the [Pinniped Go client library](https://github.com/vmware-tanzu/pinniped/tree/main/generated).
|
||||||
|
|
||||||
## Example Cluster Authentication Sequence Diagram
|
|
||||||
|
|
||||||
This diagram demonstrates using `kubectl get pods` with the Pinniped CLI configured as the credential plugin,
|
## Pinniped Deployment Strategies
|
||||||
and with a webhook IDP configured as the identity provider for the Pinniped server.
|
Pinniped can be configured to authenticate users in a variety of scenarios.
|
||||||
|
Depending on the use case, administrators can deploy the Supervisor, the Concierge,
|
||||||
|
both, or neither.
|
||||||
|
|
||||||
|
### Full Integration-- Concierge, Supervisor, and CLI
|
||||||
|
|
||||||
|
Users can authenticate with the help of the Supervisor, which will issue tokens that
|
||||||
|
can be exchanged at the Concierge for a credential that is understood by the host Kubernetes
|
||||||
|
cluster.
|
||||||
|
The Supervisor enables users to log in to their external identity provider
|
||||||
|
once per day and access each cluster in a domain with a distinct scoped-down token.
|
||||||
|
|
||||||
|
The diagram below shows the components involved in the login flow when both the Concierge
|
||||||
|
and Supervisor are configured.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
The diagram below demonstrates using `kubectl get pods` with the Pinniped CLI
|
||||||
|
functioning as a [Kubernetes client-go credential plugin](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins)
|
||||||
|
that obtains a federation ID token from the Pinniped Supervisor to be sent to a
|
||||||
|
JWT authenticator via the Pinniped Concierge.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Dynamic Cluster Authentication-- Concierge and CLI
|
||||||
|
|
||||||
|
Users can authenticate directly with their OIDC compliant external identity provider to get credentials which
|
||||||
|
can be exchanged at the Concierge for a credential that is understood by the host Kubernetes
|
||||||
|
cluster.
|
||||||
|
|
||||||
|
The diagram below shows the components involved in the login flow when the Concierge is
|
||||||
|
configured.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
The diagram below demonstrates using `kubectl get pods` with a [Kubernetes client-go credential plugin](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins)
|
||||||
|
that obtains an external credential to be sent to a webhook authenticator via the Pinniped Concierge.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Static Cluster Integration-- Supervisor and CLI
|
||||||
|
|
||||||
|
Users can authenticate with the help of the Supervisor, which will issue tokens that
|
||||||
|
can be given directly to a Kubernetes API Server that has been configured with
|
||||||
|
[OIDC Authentication.](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#openid-connect-tokens)
|
||||||
|
The Supervisor enables users to log in to their external identity provider
|
||||||
|
once per day and access each cluster in a domain with a distinct scoped-down token.
|
||||||
|
|
||||||
|
### Minimal-- CLI only
|
||||||
|
|
||||||
|
Users can authenticate directly with their OIDC compliant external identity provider to get credentials
|
||||||
|
that can be given directly to a Kubernetes API Server that has been configured with
|
||||||
|
[OIDC Authentication.](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#openid-connect-tokens)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
15
site/content/docs/concierge-and-supervisor-demo.md
Normal file
15
site/content/docs/concierge-and-supervisor-demo.md
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
---
|
||||||
|
title: "Pinniped Demo"
|
||||||
|
cascade:
|
||||||
|
layout: docs
|
||||||
|
---
|
||||||
|
|
||||||
|
# Trying Pinniped
|
||||||
|
This is the page where the supervisor demo will go.
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
## Example of Deploying on kind
|
||||||
|
|
||||||
190
site/content/docs/concierge-only-demo.md
Normal file
190
site/content/docs/concierge-only-demo.md
Normal file
@ -0,0 +1,190 @@
|
|||||||
|
---
|
||||||
|
title: "Pinniped Demo"
|
||||||
|
cascade:
|
||||||
|
layout: docs
|
||||||
|
---
|
||||||
|
|
||||||
|
# Trying Pinniped
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
1. A Kubernetes cluster of a type supported by Pinniped as described in [architecture](/docs/architecture).
|
||||||
|
|
||||||
|
Don't have a cluster handy? Consider using [kind](https://kind.sigs.k8s.io/) on your local machine.
|
||||||
|
See below for an example of using kind.
|
||||||
|
|
||||||
|
1. An authenticator of a type supported by Pinniped as described in [architecture](/docs/architecture).
|
||||||
|
|
||||||
|
Don't have an authenticator of a type supported by Pinniped handy? No problem, there is a demo authenticator
|
||||||
|
available. Start by installing local-user-authenticator on the same cluster where you would like to try Pinniped
|
||||||
|
by following the directions in [deploy/local-user-authenticator/README.md](https://github.com/vmware-tanzu/pinniped/blob/main/deploy/local-user-authenticator/README.md).
|
||||||
|
See below for an example of deploying this on kind.
|
||||||
|
|
||||||
|
1. A kubeconfig where the current context points to the cluster and has admin-like
|
||||||
|
privileges on that cluster.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
Installing and trying Pinniped on any cluster will consist of the following general steps. See the next section below
|
||||||
|
for a more specific example of installing onto a local kind cluster, including the exact commands to use for that case.
|
||||||
|
|
||||||
|
1. Install the Pinniped Concierge. See [deploy/concierge/README.md](https://github.com/vmware-tanzu/pinniped/blob/main/deploy/concierge/README.md).
|
||||||
|
1. Download the Pinniped CLI from [Pinniped's github Releases page](https://github.com/vmware-tanzu/pinniped/releases/latest).
|
||||||
|
1. Generate a kubeconfig using the Pinniped CLI. Run `pinniped get kubeconfig --help` for more information.
|
||||||
|
1. Run `kubectl` commands using the generated kubeconfig. The Pinniped Concierge will automatically be used for authentication during those commands.
|
||||||
|
|
||||||
|
## Example of Deploying on kind
|
||||||
|
|
||||||
|
[kind](https://kind.sigs.k8s.io) is a tool for creating and managing Kubernetes clusters on your local machine
|
||||||
|
which uses Docker containers as the cluster's "nodes". This is a convenient way to try out Pinniped on a local
|
||||||
|
non-production cluster.
|
||||||
|
|
||||||
|
The following steps will deploy the latest release of Pinniped on kind using the local-user-authenticator component
|
||||||
|
as the authenticator.
|
||||||
|
|
||||||
|
1. Install the tools required for the following steps.
|
||||||
|
|
||||||
|
- [Install kind](https://kind.sigs.k8s.io/docs/user/quick-start/), if not already installed. e.g. `brew install kind` on MacOS.
|
||||||
|
|
||||||
|
- kind depends on Docker. If not already installed, [install Docker](https://docs.docker.com/get-docker/), e.g. `brew cask install docker` on MacOS.
|
||||||
|
|
||||||
|
- This demo requires `kubectl`, which comes with Docker, or can be [installed separately](https://kubernetes.io/docs/tasks/tools/install-kubectl/).
|
||||||
|
|
||||||
|
- This demo requires a tool capable of generating a `bcrypt` hash in order to interact with
|
||||||
|
the webhook. The example below uses `htpasswd`, which is installed on most macOS systems, and can be
|
||||||
|
installed on some Linux systems via the `apache2-utils` package (e.g., `apt-get install
|
||||||
|
apache2-utils`).
|
||||||
|
|
||||||
|
- One of the steps below optionally uses `jq` to help find the latest release version number. It is not required.
|
||||||
|
Install `jq` if you would like, e.g. `brew install jq` on MacOS.
|
||||||
|
|
||||||
|
1. Create a new Kubernetes cluster using `kind create cluster`. Optionally provide a cluster name using the `--name` flag.
|
||||||
|
kind will automatically update your kubeconfig to point to the new cluster as a user with admin-like permissions.
|
||||||
|
|
||||||
|
1. Query GitHub's API for the git tag of the latest Pinniped
|
||||||
|
[release](https://github.com/vmware-tanzu/pinniped/releases/latest).
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pinniped_version=$(curl https://api.github.com/repos/vmware-tanzu/pinniped/releases/latest -s | jq .name -r)
|
||||||
|
```
|
||||||
|
|
||||||
|
Alternatively, [any release version](https://github.com/vmware-tanzu/pinniped/releases)
|
||||||
|
you can manually select this version of Pinniped.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Example of manually choosing a release version...
|
||||||
|
pinniped_version=v0.3.0
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Deploy the local-user-authenticator app. This is a demo authenticator. In production, you would configure
|
||||||
|
an authenticator that works with your real identity provider, and therefore would not need to deploy or configure local-user-authenticator.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
kubectl apply -f https://github.com/vmware-tanzu/pinniped/releases/download/$pinniped_version/install-local-user-authenticator.yaml
|
||||||
|
```
|
||||||
|
|
||||||
|
The `install-local-user-authenticator.yaml` file includes the default deployment options.
|
||||||
|
If you would prefer to customize the available options, please
|
||||||
|
see [deploy/local-user-authenticator/README.md](https://github.com/vmware-tanzu/pinniped/blob/main/deploy/local-user-authenticator/README.md)
|
||||||
|
for instructions on how to deploy using `ytt`.
|
||||||
|
|
||||||
|
1. Create a test user named `pinny-the-seal` in the local-user-authenticator.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
kubectl create secret generic pinny-the-seal \
|
||||||
|
--namespace local-user-authenticator \
|
||||||
|
--from-literal=groups=group1,group2 \
|
||||||
|
--from-literal=passwordHash=$(htpasswd -nbBC 10 x password123 | sed -e "s/^x://")
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Fetch the auto-generated CA bundle for the local-user-authenticator's HTTP TLS endpoint.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
kubectl get secret local-user-authenticator-tls-serving-certificate --namespace local-user-authenticator \
|
||||||
|
-o jsonpath={.data.caCertificate} \
|
||||||
|
| tee /tmp/local-user-authenticator-ca-base64-encoded
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Deploy the Pinniped Concierge.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
kubectl apply -f https://github.com/vmware-tanzu/pinniped/releases/download/$pinniped_version/install-pinniped-concierge.yaml
|
||||||
|
```
|
||||||
|
|
||||||
|
The `install-pinniped-concierge.yaml` file includes the default deployment options.
|
||||||
|
If you would prefer to customize the available options, please see [deploy/concierge/README.md](https://github.com/vmware-tanzu/pinniped/blob/main/deploy/concierge/README.md)
|
||||||
|
for instructions on how to deploy using `ytt`.
|
||||||
|
|
||||||
|
1. Create a `WebhookAuthenticator` object to configure the Pinniped Concierge to authenticate using local-user-authenticator.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cat <<EOF | kubectl create --namespace pinniped-concierge -f -
|
||||||
|
apiVersion: authentication.concierge.pinniped.dev/v1alpha1
|
||||||
|
kind: WebhookAuthenticator
|
||||||
|
metadata:
|
||||||
|
name: local-user-authenticator
|
||||||
|
spec:
|
||||||
|
endpoint: https://local-user-authenticator.local-user-authenticator.svc/authenticate
|
||||||
|
tls:
|
||||||
|
certificateAuthorityData: $(cat /tmp/local-user-authenticator-ca-base64-encoded)
|
||||||
|
EOF
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Download the latest version of the Pinniped CLI binary for your platform
|
||||||
|
from Pinniped's [latest release](https://github.com/vmware-tanzu/pinniped/releases/latest).
|
||||||
|
|
||||||
|
1. Move the Pinniped CLI binary to your preferred filename and directory. Add the executable bit,
|
||||||
|
e.g. `chmod +x /usr/local/bin/pinniped`.
|
||||||
|
|
||||||
|
1. Generate a kubeconfig for the current cluster. Use `--static-token` to include a token which should
|
||||||
|
allow you to authenticate as the user that you created above.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pinniped get kubeconfig --concierge-namespace pinniped-concierge --static-token "pinny-the-seal:password123" --concierge-authenticator-type webhook --concierge-authenticator-name local-user-authenticator > /tmp/pinniped-kubeconfig
|
||||||
|
```
|
||||||
|
|
||||||
|
If you are using MacOS, you may get an error dialog that says
|
||||||
|
`“pinniped” cannot be opened because the developer cannot be verified`. Cancel this dialog, open System Preferences,
|
||||||
|
click on Security & Privacy, and click the Allow Anyway button next to the Pinniped message.
|
||||||
|
Run the above command again and another dialog will appear saying
|
||||||
|
`macOS cannot verify the developer of “pinniped”. Are you sure you want to open it?`.
|
||||||
|
Click Open to allow the command to proceed.
|
||||||
|
|
||||||
|
1. Try using the generated kubeconfig to issue arbitrary `kubectl` commands as
|
||||||
|
the `pinny-the-seal` user.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
kubectl --kubeconfig /tmp/pinniped-kubeconfig get pods -n pinniped-concierge
|
||||||
|
```
|
||||||
|
|
||||||
|
Because this user has no RBAC permissions on this cluster, the previous command
|
||||||
|
results in the error `Error from server (Forbidden): pods is forbidden: User "pinny-the-seal" cannot list resource "pods" in API group "" in the namespace "pinniped"`.
|
||||||
|
However, this does prove that you are authenticated and acting as the `pinny-the-seal` user.
|
||||||
|
|
||||||
|
1. As the admin user, create RBAC rules for the test user to give them permissions to perform actions on the cluster.
|
||||||
|
For example, grant the test user permission to view all cluster resources.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
kubectl create clusterrolebinding pinny-can-read --clusterrole view --user pinny-the-seal
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Use the generated kubeconfig to issue arbitrary `kubectl` commands as the `pinny-the-seal` user.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
kubectl --kubeconfig /tmp/pinniped-kubeconfig get pods -n pinniped-concierge
|
||||||
|
```
|
||||||
|
|
||||||
|
The user has permission to list pods, so the command succeeds this time.
|
||||||
|
Pinniped has provided authentication into the cluster for your `kubectl` command! 🎉
|
||||||
|
|
||||||
|
1. Carry on issuing as many `kubectl` commands as you'd like as the `pinny-the-seal` user.
|
||||||
|
Each invocation will use Pinniped for authentication.
|
||||||
|
You may find it convenient to set the `KUBECONFIG` environment variable rather than passing `--kubeconfig` to each invocation.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export KUBECONFIG=/tmp/pinniped-kubeconfig
|
||||||
|
kubectl get namespaces
|
||||||
|
kubectl get pods -A
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Profit! 💰
|
||||||
@ -5,195 +5,5 @@ cascade:
|
|||||||
---
|
---
|
||||||
|
|
||||||
# Trying Pinniped
|
# Trying Pinniped
|
||||||
|
1. [Concierge with webhook demo](/docs/concierge-only-demo)
|
||||||
## Prerequisites
|
1. [Concierge with Supervisor and JWT authenticator demo](/docs/concierge-and-supervisor-demo)
|
||||||
|
|
||||||
1. A Kubernetes cluster of a type supported by Pinniped as described in [architecture](/docs/architecture).
|
|
||||||
|
|
||||||
Don't have a cluster handy? Consider using [kind](https://kind.sigs.k8s.io/) on your local machine.
|
|
||||||
See below for an example of using kind.
|
|
||||||
|
|
||||||
1. An identity provider of a type supported by Pinniped as described in [architecture](/docs/architecture).
|
|
||||||
|
|
||||||
Don't have an identity provider of a type supported by Pinniped handy? No problem, there is a demo identity provider
|
|
||||||
available. Start by installing local-user-authenticator on the same cluster where you would like to try Pinniped
|
|
||||||
by following the directions in [deploy/local-user-authenticator/README.md](https://github.com/vmware-tanzu/pinniped/blob/main/deploy/local-user-authenticator/README.md).
|
|
||||||
See below for an example of deploying this on kind.
|
|
||||||
|
|
||||||
1. A kubeconfig where the current context points to the cluster and has admin-like
|
|
||||||
privileges on that cluster.
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
Installing and trying Pinniped on any cluster will consist of the following general steps. See the next section below
|
|
||||||
for a more specific example of installing onto a local kind cluster, including the exact commands to use for that case.
|
|
||||||
|
|
||||||
1. Install Pinniped. See [deploy/concierge/README.md](https://github.com/vmware-tanzu/pinniped/blob/main/deploy/concierge/README.md).
|
|
||||||
1. Download the Pinniped CLI from [Pinniped's github Releases page](https://github.com/vmware-tanzu/pinniped/releases/latest).
|
|
||||||
1. Generate a kubeconfig using the Pinniped CLI. Run `pinniped get-kubeconfig --help` for more information.
|
|
||||||
1. Run `kubectl` commands using the generated kubeconfig. Pinniped will automatically be used for authentication during those commands.
|
|
||||||
|
|
||||||
## Example of Deploying on kind
|
|
||||||
|
|
||||||
[kind](https://kind.sigs.k8s.io) is a tool for creating and managing Kubernetes clusters on your local machine
|
|
||||||
which uses Docker containers as the cluster's "nodes". This is a convenient way to try out Pinniped on a local
|
|
||||||
non-production cluster.
|
|
||||||
|
|
||||||
The following steps will deploy the latest release of Pinniped on kind using the local-user-authenticator component
|
|
||||||
as the identity provider.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<!-- The following image was uploaded to GitHub's CDN using this awesome trick: https://gist.github.com/vinkla/dca76249ba6b73c5dd66a4e986df4c8d -->
|
|
||||||
|
|
||||||
1. Install the tools required for the following steps.
|
|
||||||
|
|
||||||
- [Install kind](https://kind.sigs.k8s.io/docs/user/quick-start/), if not already installed. e.g. `brew install kind` on MacOS.
|
|
||||||
|
|
||||||
- kind depends on Docker. If not already installed, [install Docker](https://docs.docker.com/get-docker/), e.g. `brew cask install docker` on MacOS.
|
|
||||||
|
|
||||||
- This demo requires `kubectl`, which comes with Docker, or can be [installed separately](https://kubernetes.io/docs/tasks/tools/install-kubectl/).
|
|
||||||
|
|
||||||
- This demo requires a tool capable of generating a `bcrypt` hash in order to interact with
|
|
||||||
the webhook. The example below uses `htpasswd`, which is installed on most macOS systems, and can be
|
|
||||||
installed on some Linux systems via the `apache2-utils` package (e.g., `apt-get install
|
|
||||||
apache2-utils`).
|
|
||||||
|
|
||||||
- One of the steps below optionally uses `jq` to help find the latest release version number. It is not required.
|
|
||||||
Install `jq` if you would like, e.g. `brew install jq` on MacOS.
|
|
||||||
|
|
||||||
1. Create a new Kubernetes cluster using `kind create cluster`. Optionally provide a cluster name using the `--name` flag.
|
|
||||||
kind will automatically update your kubeconfig to point to the new cluster as a user with admin-like permissions.
|
|
||||||
|
|
||||||
1. Query GitHub's API for the git tag of the latest Pinniped
|
|
||||||
[release](https://github.com/vmware-tanzu/pinniped/releases/latest).
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pinniped_version=$(curl https://api.github.com/repos/vmware-tanzu/pinniped/releases/latest -s | jq .name -r)
|
|
||||||
```
|
|
||||||
|
|
||||||
Alternatively, [any release version](https://github.com/vmware-tanzu/pinniped/releases)
|
|
||||||
number can be manually selected.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Example of manually choosing a release version...
|
|
||||||
pinniped_version=v0.2.0
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Deploy the local-user-authenticator app. This is a demo identity provider. In production, you would use your
|
|
||||||
real identity provider, and therefore would not need to deploy or configure local-user-authenticator.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
kubectl apply -f https://github.com/vmware-tanzu/pinniped/releases/download/$pinniped_version/install-local-user-authenticator.yaml
|
|
||||||
```
|
|
||||||
|
|
||||||
The `install-local-user-authenticator.yaml` file includes the default deployment options.
|
|
||||||
If you would prefer to customize the available options, please
|
|
||||||
see [deploy/local-user-authenticator/README.md](https://github.com/vmware-tanzu/pinniped/blob/main/deploy/local-user-authenticator/README.md)
|
|
||||||
for instructions on how to deploy using `ytt`.
|
|
||||||
|
|
||||||
1. Create a test user named `pinny-the-seal` in the local-user-authenticator identity provider.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
kubectl create secret generic pinny-the-seal \
|
|
||||||
--namespace local-user-authenticator \
|
|
||||||
--from-literal=groups=group1,group2 \
|
|
||||||
--from-literal=passwordHash=$(htpasswd -nbBC 10 x password123 | sed -e "s/^x://")
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Fetch the auto-generated CA bundle for the local-user-authenticator's HTTP TLS endpoint.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
kubectl get secret local-user-authenticator-tls-serving-certificate --namespace local-user-authenticator \
|
|
||||||
-o jsonpath={.data.caCertificate} \
|
|
||||||
| tee /tmp/local-user-authenticator-ca-base64-encoded
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Deploy Pinniped.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
kubectl apply -f https://github.com/vmware-tanzu/pinniped/releases/download/$pinniped_version/install-pinniped-concierge.yaml
|
|
||||||
```
|
|
||||||
|
|
||||||
The `install-pinniped-concierge.yaml` file includes the default deployment options.
|
|
||||||
If you would prefer to customize the available options, please see [deploy/concierge/README.md](https://github.com/vmware-tanzu/pinniped/blob/main/deploy/concierge/README.md)
|
|
||||||
for instructions on how to deploy using `ytt`.
|
|
||||||
|
|
||||||
1. Create a `WebhookAuthenticator` object to configure Pinniped to authenticate using local-user-authenticator.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cat <<EOF | kubectl create --namespace pinniped-concierge -f -
|
|
||||||
apiVersion: authentication.concierge.pinniped.dev/v1alpha1
|
|
||||||
kind: WebhookAuthenticator
|
|
||||||
metadata:
|
|
||||||
name: local-user-authenticator
|
|
||||||
spec:
|
|
||||||
endpoint: https://local-user-authenticator.local-user-authenticator.svc/authenticate
|
|
||||||
tls:
|
|
||||||
certificateAuthorityData: $(cat /tmp/local-user-authenticator-ca-base64-encoded)
|
|
||||||
EOF
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Download the latest version of the Pinniped CLI binary for your platform
|
|
||||||
from Pinniped's [latest release](https://github.com/vmware-tanzu/pinniped/releases/latest).
|
|
||||||
|
|
||||||
1. Move the Pinniped CLI binary to your preferred filename and directory. Add the executable bit,
|
|
||||||
e.g. `chmod +x /usr/local/bin/pinniped`.
|
|
||||||
|
|
||||||
1. Generate a kubeconfig for the current cluster. Use `--token` to include a token which should
|
|
||||||
allow you to authenticate as the user that you created above.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pinniped get-kubeconfig --pinniped-namespace pinniped-concierge --token "pinny-the-seal:password123" --authenticator-type webhook --authenticator-name local-user-authenticator > /tmp/pinniped-kubeconfig
|
|
||||||
```
|
|
||||||
|
|
||||||
If you are using MacOS, you may get an error dialog that says
|
|
||||||
`“pinniped” cannot be opened because the developer cannot be verified`. Cancel this dialog, open System Preferences,
|
|
||||||
click on Security & Privacy, and click the Allow Anyway button next to the Pinniped message.
|
|
||||||
Run the above command again and another dialog will appear saying
|
|
||||||
`macOS cannot verify the developer of “pinniped”. Are you sure you want to open it?`.
|
|
||||||
Click Open to allow the command to proceed.
|
|
||||||
|
|
||||||
Note that the above command will print a warning to the screen. You can ignore this warning.
|
|
||||||
Pinniped tries to auto-discover the URL for the Kubernetes API server, but it is not able
|
|
||||||
to do so on kind clusters. The warning is just letting you know that the Pinniped CLI decided
|
|
||||||
to ignore the auto-discovery URL and instead use the URL from your existing kubeconfig.
|
|
||||||
|
|
||||||
1. Try using the generated kubeconfig to issue arbitrary `kubectl` commands as
|
|
||||||
the `pinny-the-seal` user.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
kubectl --kubeconfig /tmp/pinniped-kubeconfig get pods -n pinniped-concierge
|
|
||||||
```
|
|
||||||
|
|
||||||
Because this user has no RBAC permissions on this cluster, the previous command
|
|
||||||
results in the error `Error from server (Forbidden): pods is forbidden: User "pinny-the-seal" cannot list resource "pods" in API group "" in the namespace "pinniped"`.
|
|
||||||
However, this does prove that you are authenticated and acting as the `pinny-the-seal` user.
|
|
||||||
|
|
||||||
1. As the admin user, create RBAC rules for the test user to give them permissions to perform actions on the cluster.
|
|
||||||
For example, grant the test user permission to view all cluster resources.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
kubectl create clusterrolebinding pinny-can-read --clusterrole view --user pinny-the-seal
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Use the generated kubeconfig to issue arbitrary `kubectl` commands as the `pinny-the-seal` user.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
kubectl --kubeconfig /tmp/pinniped-kubeconfig get pods -n pinniped-concierge
|
|
||||||
```
|
|
||||||
|
|
||||||
The user has permission to list pods, so the command succeeds this time.
|
|
||||||
Pinniped has provided authentication into the cluster for your `kubectl` command! 🎉
|
|
||||||
|
|
||||||
1. Carry on issuing as many `kubectl` commands as you'd like as the `pinny-the-seal` user.
|
|
||||||
Each invocation will use Pinniped for authentication.
|
|
||||||
You may find it convenient to set the `KUBECONFIG` environment variable rather than passing `--kubeconfig` to each invocation.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
export KUBECONFIG=/tmp/pinniped-kubeconfig
|
|
||||||
kubectl get namespaces
|
|
||||||
kubectl get pods -A
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Profit! 💰
|
|
||||||
|
|||||||
@ -2,8 +2,15 @@
|
|||||||
|
|
||||||
## How to Update these Images
|
## How to Update these Images
|
||||||
|
|
||||||
- [pinniped.svg](pinniped.svg) was generated using [`plantuml`](https://plantuml.com/).
|
- [pinniped-concierge-sequence.svg](pinniped-concierge-sequence.svg) was
|
||||||
To regenerate the image, run `plantuml -tsvg pinniped.txt` from this directory.
|
generated using [`plantuml`](https://plantuml.com/). To regenerate the image,
|
||||||
|
run `plantuml -tsvg pinniped.txt` from this directory, or go to
|
||||||
|
https://www.planttext.com/.
|
||||||
|
|
||||||
|
- [pinniped-concierge-supervisor-sequence.svg](pinniped-concierge-supervisor-sequence.svg)
|
||||||
|
was generated using [`plantuml`](https://plantuml.com/). To regenerate the
|
||||||
|
image, run `plantuml -tsvg pinniped.txt` from this directory, or go to
|
||||||
|
https://www.planttext.com/.
|
||||||
|
|
||||||
- [pinniped_architecture.svg](pinniped_architecture.svg) was created on [draw.io](https://draw.io).
|
- [pinniped_architecture.svg](pinniped_architecture.svg) was created on [draw.io](https://draw.io).
|
||||||
It can be opened again for editing on that site by choosing "File" -> "Open from" -> "Device".
|
It can be opened again for editing on that site by choosing "File" -> "Open from" -> "Device".
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 43 KiB After Width: | Height: | Size: 43 KiB |
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 22 KiB |
@ -0,0 +1,52 @@
|
|||||||
|
@startuml Login
|
||||||
|
|
||||||
|
actor User
|
||||||
|
|
||||||
|
box "Workstation"
|
||||||
|
participant Browser
|
||||||
|
participant Kubectl
|
||||||
|
participant "Pinniped CLI"
|
||||||
|
end box
|
||||||
|
|
||||||
|
box "Supervisor Cluster"
|
||||||
|
participant Pinniped as sp
|
||||||
|
end box
|
||||||
|
|
||||||
|
box "Concierge Cluster"
|
||||||
|
participant Pinniped as wp
|
||||||
|
end box
|
||||||
|
|
||||||
|
box "Corporate Network"
|
||||||
|
participant "OIDC IDP" as IDP
|
||||||
|
end box
|
||||||
|
|
||||||
|
User -> Kubectl: kubectl get pods
|
||||||
|
Kubectl -> "Pinniped CLI" : get credential for cluster authentication
|
||||||
|
"Pinniped CLI" -> "Pinniped CLI": starts localhost listener
|
||||||
|
"Pinniped CLI" -> User: open browser to URL X
|
||||||
|
User -> Browser: clicks link
|
||||||
|
Browser -> sp : ""GET https://supervisor.com/oauth2/authorize""
|
||||||
|
sp -> Browser: 302 to IDP ""/authorize?redirect_uri=https://supervisor.com/callback""
|
||||||
|
Browser -> IDP: ""GET /authorize?redirect_uri=https://supervisor.com/callback""
|
||||||
|
IDP -> IDP: IDP authenticates user
|
||||||
|
IDP -> Browser: 302 to ""https://supervisor.com/callback""
|
||||||
|
Browser -> sp: ""GET https://supervisor.com/callback""
|
||||||
|
sp -> IDP: ""POST /token""
|
||||||
|
IDP -> sp: access token, ID token, refresh token
|
||||||
|
sp -> Browser: 302 to ""http://localhost:1234/callback""
|
||||||
|
Browser -> "Pinniped CLI": ""GET http://localhost:1234/callback""
|
||||||
|
"Pinniped CLI" -> sp: ""POST https://supervisor.com/oauth2/token""
|
||||||
|
sp -> sp: lookup auth code
|
||||||
|
sp -> sp: issue refresh token
|
||||||
|
sp -> sp: issue ID+access tokens
|
||||||
|
sp -> "Pinniped CLI": refresh+access+ID tokens
|
||||||
|
"Pinniped CLI" -> sp: ""POST /oauth2/token"" (w/ access token per RFC8693)
|
||||||
|
sp -> "Pinniped CLI": cluster-specific ID token
|
||||||
|
"Pinniped CLI" -> wp: create TokenCredentialRequest (w/ cluster-specific ID token)
|
||||||
|
wp -> "Pinniped CLI": cluster-specific certificate and key
|
||||||
|
"Pinniped CLI" -> Kubectl: cluster-specific certificate and key
|
||||||
|
Kubectl -> wp : ""GET /api/v1/pods""
|
||||||
|
wp -> wp : Glean user and group information from\ncluster-specific credential
|
||||||
|
wp -> Kubectl : ""200 OK"" with pods
|
||||||
|
|
||||||
|
@enduml
|
||||||
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 96 KiB |
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 66 KiB |
21
site/content/docs/install.md
Normal file
21
site/content/docs/install.md
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
---
|
||||||
|
title: "Installing Pinniped"
|
||||||
|
cascade:
|
||||||
|
layout: docs
|
||||||
|
---
|
||||||
|
|
||||||
|
# Installing Pinniped
|
||||||
|
|
||||||
|
## Install the CLI
|
||||||
|
|
||||||
|
- Find the appropriate binary for your platform from the [latest release](https://github.com/vmware-tanzu/pinniped/releases/latest).
|
||||||
|
|
||||||
|
- Use Homebrew on macOS: `brew install vmware-tanzu/pinniped/pinniped-cli`.
|
||||||
|
|
||||||
|
## Install the Concierge
|
||||||
|
|
||||||
|
- See the [concierge deployment guide](https://github.com/vmware-tanzu/pinniped/tree/main/deploy/concierge).
|
||||||
|
|
||||||
|
## Install the Supervisor
|
||||||
|
|
||||||
|
- See the [supervisor deployment guide](https://github.com/vmware-tanzu/pinniped/tree/main/deploy/supervisor).
|
||||||
@ -8,7 +8,7 @@ cascade:
|
|||||||
# Project Scope
|
# Project Scope
|
||||||
|
|
||||||
The Pinniped project is guided by the following principles.
|
The Pinniped project is guided by the following principles.
|
||||||
* Pinniped lets you plug any external identitiy providers into
|
* Pinniped lets you plug any external identity providers into
|
||||||
Kubernetes. These integrations follow enterprise-grade security principles.
|
Kubernetes. These integrations follow enterprise-grade security principles.
|
||||||
* Pinniped is easy to install and use on any Kubernetes cluster via
|
* Pinniped is easy to install and use on any Kubernetes cluster via
|
||||||
distribution-specific integration mechanisms.
|
distribution-specific integration mechanisms.
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user