Move scope doc out of website to SCOPE.md.
This is contributor-focused, so we decided to move it into GitHub only for now. Signed-off-by: Matt Moyer <moyerm@vmware.com>
This commit is contained in:
parent
4de949fe18
commit
3721632de2
@ -8,7 +8,7 @@ Please see the [Code of Conduct](./CODE_OF_CONDUCT.md).
|
|||||||
|
|
||||||
## Project Scope
|
## Project Scope
|
||||||
|
|
||||||
Learn about the [scope](https://pinniped.dev/docs/scope/) of the project.
|
See [SCOPE.md](./SCOPE.md) for some guidelines about what we consider in and out of scope for Pinniped.
|
||||||
|
|
||||||
## Community Meetings
|
## Community Meetings
|
||||||
|
|
||||||
|
32
SCOPE.md
Normal file
32
SCOPE.md
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
# Project Scope
|
||||||
|
|
||||||
|
The Pinniped project is guided by the following principles.
|
||||||
|
|
||||||
|
- Pinniped lets you plug any external identity providers into Kubernetes.
|
||||||
|
These integrations follow enterprise-grade security principles.
|
||||||
|
- Pinniped is easy to install and use on any Kubernetes cluster via distribution-specific integration mechanisms.
|
||||||
|
- Pinniped uses a declarative configuration via Kubernetes APIs.
|
||||||
|
- Pinniped provides optimal user experience when authenticating to many clusters at one time.
|
||||||
|
- Pinniped provides enterprise-grade security posture via secure defaults and revocable or very short-lived credentials.
|
||||||
|
- Where possible, Pinniped will contribute ideas and code to upstream Kubernetes.
|
||||||
|
|
||||||
|
When contributing to Pinniped, please consider whether your contribution follows
|
||||||
|
these guiding principles.
|
||||||
|
|
||||||
|
## Out Of Scope
|
||||||
|
|
||||||
|
The following items are out of scope for the Pinniped project.
|
||||||
|
|
||||||
|
- Authorization.
|
||||||
|
- Standalone identity provider for general use.
|
||||||
|
- Machine-to-machine (service) identity.
|
||||||
|
- Running outside of Kubernetes.
|
||||||
|
|
||||||
|
## Roadmap
|
||||||
|
|
||||||
|
See our [open milestones][milestones] and the [`priority/backlog` label][backlog] for an idea about what's next on our roadmap.
|
||||||
|
|
||||||
|
For more details on proposing features and bugs, check out our [contributing](./CONTRIBUTING.md) doc.
|
||||||
|
|
||||||
|
[milestones]: https://github.com/vmware-tanzu/pinniped/milestones
|
||||||
|
[backlog]: https://github.com/vmware-tanzu/pinniped/labels/priority%2Fbacklog
|
@ -1,43 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Pinniped Scope"
|
|
||||||
cascade:
|
|
||||||
layout: docs
|
|
||||||
menu:
|
|
||||||
docs:
|
|
||||||
name: Scope
|
|
||||||
weight: 200
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
# Project Scope
|
|
||||||
|
|
||||||
The Pinniped project is guided by the following principles.
|
|
||||||
* Pinniped lets you plug any external identity providers into
|
|
||||||
Kubernetes. These integrations follow enterprise-grade security principles.
|
|
||||||
* Pinniped is easy to install and use on any Kubernetes cluster via
|
|
||||||
distribution-specific integration mechanisms.
|
|
||||||
* Pinniped uses a declarative configuration via Kubernetes APIs.
|
|
||||||
* Pinniped provides optimal user experience when authenticating to many
|
|
||||||
clusters at one time.
|
|
||||||
* Pinniped provides enterprise-grade security posture via secure defaults and
|
|
||||||
revocable or very short-lived credentials.
|
|
||||||
* Where possible, Pinniped will contribute ideas and code to upstream
|
|
||||||
Kubernetes.
|
|
||||||
|
|
||||||
When contributing to Pinniped, please consider whether your contribution follows
|
|
||||||
these guiding principles.
|
|
||||||
|
|
||||||
## Out Of Scope
|
|
||||||
|
|
||||||
The following items are out of scope for the Pinniped project.
|
|
||||||
* Authorization.
|
|
||||||
* Standalone identity provider for general use.
|
|
||||||
* Machine-to-machine (service) identity.
|
|
||||||
* Running outside of Kubernetes.
|
|
||||||
|
|
||||||
## Roadmap
|
|
||||||
|
|
||||||
More details coming soon!
|
|
||||||
|
|
||||||
For more details on proposing features and bugs, check out our
|
|
||||||
[contributing](https://github.com/vmware-tanzu/pinniped/blob/main/CONTRIBUTING.md) doc.
|
|
Loading…
Reference in New Issue
Block a user