Remove duplicate documentation images from the repo and change all links to point to the Hugo site
This commit is contained in:
Rajat Goyal
parent
31810a97e1
commit
7e78c9322c
@ -1,4 +1,4 @@
|
|||||||
<img src="doc/img/pinniped_logo.svg" alt="Pinniped Logo" width="100%"/>
|
<img src="site/content/docs/img/pinniped_logo.svg" alt="Pinniped Logo" width="100%"/>
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
@ -30,7 +30,7 @@ distributions to make authentication possible.
|
|||||||
|
|
||||||
To learn more, see [architecture](https://pinniped.dev/docs/architecture/).
|
To learn more, see [architecture](https://pinniped.dev/docs/architecture/).
|
||||||
|
|
||||||
<img src="doc/img/pinniped_architecture.svg" alt="Pinniped Architecture Sketch" width="300px"/>
|
<img src="site/content/docs/img/pinniped_architecture.svg" alt="Pinniped Architecture Sketch" width="300px"/>
|
||||||
|
|
||||||
## Trying Pinniped
|
## Trying Pinniped
|
||||||
|
|
||||||
|
|||||||
@ -1,12 +0,0 @@
|
|||||||
# `doc/img` README
|
|
||||||
|
|
||||||
## How to Update these Images
|
|
||||||
|
|
||||||
- [pinniped.svg](pinniped.svg) was generated using [`plantuml`](https://plantuml.com/).
|
|
||||||
To regenerate the image, run `plantuml -tsvg pinniped.txt` from this directory.
|
|
||||||
|
|
||||||
- [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".
|
|
||||||
Because it includes embedded icons it should be exported using "File" -> "Export as" -> "SVG",
|
|
||||||
with the "Transparent Background", "Embed Images", and "Include a copy of my diagram" options
|
|
||||||
checked. The icons in this diagram are from their "CAE" shapes set.
|
|
||||||
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 43 KiB |
@ -1,61 +0,0 @@
|
|||||||
@startuml "pinniped"
|
|
||||||
|
|
||||||
!define K8S_BLUE #326CE5
|
|
||||||
!define K8S_SPRITES_URL https://raw.githubusercontent.com/michiel/plantuml-kubernetes-sprites/master/resource
|
|
||||||
!include K8S_SPRITES_URL/k8s-sprites-unlabeled-25pct.iuml
|
|
||||||
|
|
||||||
participant "User" as USER << ($pod{scale=0.30},K8S_BLUE) >> #LightGreen
|
|
||||||
participant "Kubectl" as KUBECTL << ($ing{scale=0.30},K8S_BLUE) >> #LightSteelBlue
|
|
||||||
participant "Proprietary CLI" as CLI << ($svc{scale=0.30},K8S_BLUE) >> #LightPink
|
|
||||||
participant "Pinniped" as PINNIPED << ($node{scale=0.30},K8S_BLUE) >> #LightGray
|
|
||||||
participant "TokenReview Webhook" as WEBHOOK << ($pod{scale=0.30},K8S_BLUE) >> #LightPink
|
|
||||||
participant "Kubernetes API" as API << ($node{scale=0.30},K8S_BLUE) >> #LightSteelBlue
|
|
||||||
|
|
||||||
legend
|
|
||||||
# <back:lightsalmon>Message contains upstream IDP credentials</back>
|
|
||||||
# <back:lightgreen>Message contains cluster-specific credentials</back>
|
|
||||||
end legend
|
|
||||||
|
|
||||||
USER -> KUBECTL : ""kubectl get pods""
|
|
||||||
activate KUBECTL
|
|
||||||
|
|
||||||
group Acquire cluster-specific credential
|
|
||||||
|
|
||||||
KUBECTL -> CLI : Get cluster-specific credential
|
|
||||||
activate CLI
|
|
||||||
|
|
||||||
CLI -> CLI : Retrieve upstream IDP credential in\norganization-specific way
|
|
||||||
|
|
||||||
CLI -> PINNIPED : <back:lightsalmon>""POST /apis/pinniped.dev/...""</back>
|
|
||||||
activate PINNIPED
|
|
||||||
|
|
||||||
PINNIPED -> WEBHOOK : <back:lightsalmon>""POST /authenticate""</back>
|
|
||||||
activate WEBHOOK
|
|
||||||
|
|
||||||
WEBHOOK -> PINNIPED : ""200 OK"" with user and group information
|
|
||||||
deactivate WEBHOOK
|
|
||||||
|
|
||||||
PINNIPED -> PINNIPED : Issue short-lived cluster-specific credential\nwith user and group information
|
|
||||||
|
|
||||||
PINNIPED -> CLI : <back:lightgreen>""200 OK""</back>
|
|
||||||
deactivate PINNIPED
|
|
||||||
|
|
||||||
CLI -> KUBECTL : Here is a cluster-specific credential
|
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
group Authenticate to cluster with cluster-specific credential
|
|
||||||
|
|
||||||
KUBECTL -> API : <back:lightgreen>""GET /api/v1/pods""</back>
|
|
||||||
activate API
|
|
||||||
|
|
||||||
API -> API : Glean user and group information from\ncluster-specific credential
|
|
||||||
|
|
||||||
API -> KUBECTL : ""200 OK"" with pods
|
|
||||||
deactivate API
|
|
||||||
|
|
||||||
deactivate KUBECTL
|
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
@enduml
|
|
||||||
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 79 KiB |
@ -1,68 +0,0 @@
|
|||||||
<svg id="artwork" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 486 158"><metadata><?xpacket begin="" id="W5M0MpCehiHzreSzNTczkc9d"?>
|
|
||||||
<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="Adobe XMP Core 6.0-c002 79.164352, 2020/01/30-15:50:38 ">
|
|
||||||
<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
|
|
||||||
<rdf:Description rdf:about=""
|
|
||||||
xmlns:lr="http://ns.adobe.com/lightroom/1.0/"
|
|
||||||
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
|
||||||
xmlns:xmp="http://ns.adobe.com/xap/1.0/"
|
|
||||||
xmlns:xmpMM="http://ns.adobe.com/xap/1.0/mm/"
|
|
||||||
xmlns:stEvt="http://ns.adobe.com/xap/1.0/sType/ResourceEvent#">
|
|
||||||
<lr:hierarchicalSubject>
|
|
||||||
<rdf:Bag>
|
|
||||||
<rdf:li>open source identity</rdf:li>
|
|
||||||
<rdf:li>open source identity|636062</rdf:li>
|
|
||||||
<rdf:li>open source identity|Pinniped</rdf:li>
|
|
||||||
</rdf:Bag>
|
|
||||||
</lr:hierarchicalSubject>
|
|
||||||
<dc:subject>
|
|
||||||
<rdf:Bag>
|
|
||||||
<rdf:li>open source identity</rdf:li>
|
|
||||||
<rdf:li>636062</rdf:li>
|
|
||||||
<rdf:li>Pinniped</rdf:li>
|
|
||||||
</rdf:Bag>
|
|
||||||
</dc:subject>
|
|
||||||
<xmp:MetadataDate>2020-09-17T16:06:40-07:00</xmp:MetadataDate>
|
|
||||||
<xmpMM:InstanceID>xmp.iid:932334bf-97ee-471a-96c9-c4e5ff526fe4</xmpMM:InstanceID>
|
|
||||||
<xmpMM:DocumentID>xmp.did:38396587-b56b-42c3-8f3e-f8e9c91f532b</xmpMM:DocumentID>
|
|
||||||
<xmpMM:OriginalDocumentID>xmp.did:38396587-b56b-42c3-8f3e-f8e9c91f532b</xmpMM:OriginalDocumentID>
|
|
||||||
<xmpMM:History>
|
|
||||||
<rdf:Seq>
|
|
||||||
<rdf:li>
|
|
||||||
<rdf:Description>
|
|
||||||
<stEvt:action>saved</stEvt:action>
|
|
||||||
<stEvt:instanceID>xmp.iid:38396587-b56b-42c3-8f3e-f8e9c91f532b</stEvt:instanceID>
|
|
||||||
<stEvt:when>2020-09-17T16:06:35-07:00</stEvt:when>
|
|
||||||
<stEvt:softwareAgent>Adobe Bridge 2020 (Macintosh)</stEvt:softwareAgent>
|
|
||||||
<stEvt:changed>/metadata</stEvt:changed>
|
|
||||||
</rdf:Description>
|
|
||||||
</rdf:li>
|
|
||||||
<rdf:li>
|
|
||||||
<rdf:Description>
|
|
||||||
<stEvt:action>saved</stEvt:action>
|
|
||||||
<stEvt:instanceID>xmp.iid:932334bf-97ee-471a-96c9-c4e5ff526fe4</stEvt:instanceID>
|
|
||||||
<stEvt:when>2020-09-17T16:06:40-07:00</stEvt:when>
|
|
||||||
<stEvt:softwareAgent>Adobe Bridge 2020 (Macintosh)</stEvt:softwareAgent>
|
|
||||||
<stEvt:changed>/metadata</stEvt:changed>
|
|
||||||
</rdf:Description>
|
|
||||||
</rdf:li>
|
|
||||||
</rdf:Seq>
|
|
||||||
</xmpMM:History>
|
|
||||||
</rdf:Description>
|
|
||||||
</rdf:RDF>
|
|
||||||
</x:xmpmeta>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<?xpacket end="w"?></metadata>
|
|
||||||
<defs><style>.cls-1{fill:#717073;}.cls-2{fill:#727174;}.cls-3{fill:#fff;}.cls-4{fill:#78be43;}.cls-5{fill:#1abfd3;}.cls-6{fill:#79459b;}.cls-7{fill:#1e4488;}.cls-8{fill:#218fcf;}</style></defs><path class="cls-1" d="M170.52,58.21h16.74a17.43,17.43,0,0,1,7.68,1.68,13.45,13.45,0,0,1,5.49,4.71,12.54,12.54,0,0,1,0,13.62,13.45,13.45,0,0,1-5.49,4.71,17.43,17.43,0,0,1-7.68,1.68H175.2V99.43h-4.68Zm15.9,22a13.23,13.23,0,0,0,8.19-2.34,8.21,8.21,0,0,0,0-12.84,13.23,13.23,0,0,0-8.19-2.34H175.2V80.17Z"/><path class="cls-1" d="M209.82,58.21h4.68V99.43h-4.68Z"/><path class="cls-1" d="M225.78,58.21h4.68L256,91.75V58.21h4.68V99.43H256L230.46,65.89V99.43h-4.68Z"/><path class="cls-1" d="M272,58.21h4.68l25.56,33.54V58.21h4.68V99.43h-4.68L276.66,65.89V99.43H272Z"/><path class="cls-1" d="M318.18,58.21h4.68V99.43h-4.68Z"/><path class="cls-1" d="M334.14,58.21h16.74a17.46,17.46,0,0,1,7.68,1.68,13.51,13.51,0,0,1,5.49,4.71,12.54,12.54,0,0,1,0,13.62,13.51,13.51,0,0,1-5.49,4.71,17.46,17.46,0,0,1-7.68,1.68H338.82V99.43h-4.68Zm15.9,22a13.23,13.23,0,0,0,8.19-2.34,8.21,8.21,0,0,0,0-12.84A13.23,13.23,0,0,0,350,62.65H338.82V80.17Z"/><path class="cls-1" d="M378.18,62.65V76.21h22.38v4.44H378.18V95H403v4.44H373.44V58.21H403v4.44Z"/><path class="cls-1" d="M411.12,58.21H425a24.6,24.6,0,0,1,11.54,2.64,19.73,19.73,0,0,1,7.92,7.32,21.2,21.2,0,0,1,0,21.27,19.66,19.66,0,0,1-7.92,7.35A24.6,24.6,0,0,1,425,99.43H411.12Zm13.92,37a19.21,19.21,0,0,0,9.08-2.1,15.61,15.61,0,0,0,6.25-5.82,17,17,0,0,0,0-16.89,15.68,15.68,0,0,0-6.25-5.79,19.21,19.21,0,0,0-9.08-2.1h-9.25v32.7Z"/><path class="cls-2" d="M91.14,25.5A52.5,52.5,0,1,0,143.64,78,52.51,52.51,0,0,0,91.14,25.5Zm0,95.33A42.83,42.83,0,1,1,134,78,42.83,42.83,0,0,1,91.14,120.83Z"/><circle class="cls-3" cx="91.33" cy="77.84" r="45.75"/><circle class="cls-4" cx="91.16" cy="76.71" r="8"/><path class="cls-5" d="M118.92,58.45l1.66,6.89,5.12-.66-3-12.42-.15-.5v0l-11.73-5.08-1.53,5,6.48,2.8L101.26,66.65a14.14,14.14,0,0,1,2.9,4.24Z"/><path class="cls-6" d="M66.46,54.41,73,51.61l-1.53-5L59.68,51.73v0l-.15.5-3,12.42,5.13.66,1.65-6.89L78.13,70.94A14.23,14.23,0,0,1,81,66.68Z"/><path class="cls-7" d="M57.49,82.82,59.21,76l-4.87-1.8L51.23,86.56l0,0,.31.42,8,9.94,3.66-3.66-4.47-5.51,19.82-4.35A14.23,14.23,0,0,1,77,78.54Z"/><path class="cls-7" d="M128,74.17,123.11,76l1.72,6.85-19.54-4.28a14.23,14.23,0,0,1-1.56,4.89l19.81,4.35-4.46,5.51L122.73,97l8-9.94.31-.42,0,0Z"/><path class="cls-6" d="M103.35,109l-7.08-.33-.79,5.11,12.76.58h.56l8.14-9.86-4.34-2.85-4.5,5.45-8.43-19a14.36,14.36,0,0,1-4.58,2.28Z"/><path class="cls-5" d="M74.24,107.08l-4.5-5.45-4.34,2.85,8.14,9.86h.56l12.76-.58-.78-5.11L79,109l8.26-18.57a14.28,14.28,0,0,1-4.59-2.27Z"/><path class="cls-8" d="M93.78,62.7V43.84L100.12,47l2.79-4.35L91.49,37,91,36.74h0l-11.44,5.7,2.8,4.37,6.33-3.15v19a14.59,14.59,0,0,1,2.49-.23A15,15,0,0,1,93.78,62.7Z"/></svg>
|
|
||||||
|
Before Width: | Height: | Size: 5.4 KiB |
@ -1,4 +1,4 @@
|
|||||||
# doc/img README
|
# site/content/docs/img README
|
||||||
|
|
||||||
## How to Update these Images
|
## How to Update these Images
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user